Scaleway logo
IAM API
IAM API

SCIM

Download schema

System for Cross-domain Identity Management (SCIM) is an open standard that allows you to automate the exchange of user identity information between your identity provider and Scaleway. With SCIM, you can manage user provisioning and deprovisioning, as well as group management, directly from your identity provider, ensuring that your IAM users and groups are always up to date.

Get SCIM configuration of an Organization

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

Get SCIM configuration of an Organization › path Parameters

organization_id
​string · required

Get SCIM configuration of an Organization › Responses

200
scaleway.iam.v1alpha1.Scim
id
​string

ID of the SCIM configuration.

created_at
​string | null · date-time

Date and time of SCIM configuration creation. (RFC 3339 format)

Enable SCIM for an Organization

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

Enable SCIM for an Organization › path Parameters

organization_id
​string · required

ID of the Organization.

Enable SCIM for an Organization › Request Body

Enable SCIM for an Organization › Responses

200
scaleway.iam.v1alpha1.Scim
id
​string

ID of the SCIM configuration.

created_at
​string | null · date-time

Date and time of SCIM configuration creation. (RFC 3339 format)

Delete a SCIM token

DELETE
https://api.scaleway.com
/iam/v1alpha1/scim-tokens/{token_id}

Delete a SCIM token › path Parameters

token_id
​string · required

The SCIM token ID.

Delete a SCIM token › Responses

No data returned

Disable SCIM for an Organization

DELETE
https://api.scaleway.com
/iam/v1alpha1/scim/{scim_id}

Disable SCIM for an Organization › path Parameters

scim_id
​string · required

ID of the SCIM configuration.

Disable SCIM for an Organization › Responses

No data returned

List SCIM tokens

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

List SCIM tokens › path Parameters

scim_id
​string · required

ID of the SCIM configuration.

List SCIM tokens › query Parameters

Sort order of SCIM tokens.

Enum values:
created_at_asc
created_at_desc
Default: created_at_asc
page
​integer · int32

Requested page number. Value must be greater or equal to 1.

page_size
​integer · uint32

Number of items per page. Value must be between 1 and 100.

List SCIM tokens › Responses

200
scaleway.iam.v1alpha1.ListScimTokensResponse

List of SCIM tokens.

total_count
​integer · uint64

Total count of SCIM tokens.

Create a SCIM token

POST
https://api.scaleway.com
/iam/v1alpha1/scim/{scim_id}/tokens

Create a SCIM token › path Parameters

scim_id
​string · required

ID of the SCIM configuration.

Create a SCIM token › Responses

200
scaleway.iam.v1alpha1.CreateScimTokenResponse

The SCIM token metadata.

bearer_token
​string

The Bearer Token to use to authenticate to SCIM endpoints.

SAMLSecurity Settings