Scaleway logo
IAM API
IAM API

Other endpoints

Download schema

POST
https://api.scaleway.com
/iam/v1alpha1/check-permissions

Request Body

Responses

Get your Organization's IAM information

GET
https://api.scaleway.com
/iam/v1alpha1/organizations/{organization_id}

Get your Organization's IAM information › path Parameters

organization_id
​string · required

ID of the Organization.

Get your Organization's IAM information › Responses

200
scaleway.iam.v1alpha1.Organization
id
​string

ID of the Organization.

name
​string

Name of the Organization.

alias
​string

Alias of the Organization.

login_password_enabled
​boolean

Defines whether login with a password is enabled for the Organization.

login_magic_code_enabled
​boolean

Defines whether login with an authentication code is enabled for the Organization.

login_oauth2_enabled
​boolean

Defines whether login through OAuth2 is enabled for the Organization.

login_saml_enabled
​boolean

Defines whether login through SAML is enabled for the Organization.

Set your Organization's alias.

PUT
https://api.scaleway.com
/iam/v1alpha1/organizations/{organization_id}/alias

This will fail if an alias has already been defined. Please contact support if you need to change your Organization's alias.

Set your Organization's alias. › path Parameters

organization_id
​string · required

ID of the Organization.

Set your Organization's alias. › Request Body

alias
​string

Alias of the Organization.

Set your Organization's alias. › Responses

200
scaleway.iam.v1alpha1.Organization
id
​string

ID of the Organization.

name
​string

Name of the Organization.

alias
​string

Alias of the Organization.

login_password_enabled
​boolean

Defines whether login with a password is enabled for the Organization.

login_magic_code_enabled
​boolean

Defines whether login with an authentication code is enabled for the Organization.

login_oauth2_enabled
​boolean

Defines whether login through OAuth2 is enabled for the Organization.

login_saml_enabled
​boolean

Defines whether login through SAML is enabled for the Organization.

Set your Organization's allowed login methods.

PATCH
https://api.scaleway.com
/iam/v1alpha1/organizations/{organization_id}/login-methods

Set your Organization's allowed login methods. › path Parameters

organization_id
​string · required

ID of the Organization.

Set your Organization's allowed login methods. › Request Body

login_password_enabled
​boolean | null

Defines whether login with a password is enabled for the Organization.

login_oauth2_enabled
​boolean | null

Defines whether login through OAuth2 is enabled for the Organization.

login_magic_code_enabled
​boolean | null

Defines whether login with an authentication code is enabled for the Organization.

login_saml_enabled
​boolean | null

Defines whether login through SAML is enabled for the Organization.

Set your Organization's allowed login methods. › Responses

200
scaleway.iam.v1alpha1.Organization
id
​string

ID of the Organization.

name
​string

Name of the Organization.

alias
​string

Alias of the Organization.

login_password_enabled
​boolean

Defines whether login with a password is enabled for the Organization.

login_magic_code_enabled
​boolean

Defines whether login with an authentication code is enabled for the Organization.

login_oauth2_enabled
​boolean

Defines whether login through OAuth2 is enabled for the Organization.

login_saml_enabled
​boolean

Defines whether login through SAML is enabled for the Organization.

GET
https://api.scaleway.com
/iam/v1alpha1/scim-tokens/{scim_token_id}

path Parameters

scim_token_id
​string · required

Responses

200
scaleway.iam.v1alpha1.ScimToken
id
​string

(UUID format)

scim_id
​string

(UUID format)

created_at
​string | null · date-time

(RFC 3339 format)

expires_at
​string | null · date-time

(RFC 3339 format)

GET
https://api.scaleway.com
/iam/v1alpha1/users/{user_id}/connections

path Parameters

user_id
​string · required

ID of the user to list connections for.

Responses

POST
https://api.scaleway.com
/iam/v1alpha1/users/{user_id}/initiate-connection

path Parameters

user_id
​string · required

ID of the user that will be added to your connection.

Request Body

Responses

200
scaleway.iam.v1alpha1.InitiateUserConnectionResponse
token
​string

Token to be used in JoinUserConnection.

POST
https://api.scaleway.com
/iam/v1alpha1/users/{user_id}/join-connection

path Parameters

user_id
​string · required

User ID.

Request Body

token
​string

A token returned by InitiateUserConnection.

Responses

No data returned

POST
https://api.scaleway.com
/iam/v1alpha1/users/{user_id}/remove-connection

path Parameters

user_id
​string · required

ID of the user you want to manage the connection for.

Request Body

target_user_id
​string

ID of the user you want to remove from your connection.

Responses

No data returned
Security Settings