Scaleway logo
IAM API
IAM API

SAML

Download schema

Scaleway supports Identity Federation to provide your teams with secure access to their accounts via Single Sign-On (SSO). Depending on your organization's requirements, you can use either built-in OAuth2 providers or configure SAML for centralized identity management.

Get SAML Identity Provider configuration of an Organization

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

Get SAML Identity Provider configuration of an Organization › path Parameters

organization_id
​string · required

ID of the Organization.

Get SAML Identity Provider configuration of an Organization › Responses

200
scaleway.iam.v1alpha1.Saml
id
​string

ID of the SAML configuration.

status
​scaleway.iam.v1alpha1.Saml.Status · enum

Status of the SAML configuration.

Enum values:
unknown_saml_status
valid
missing_certificate
missing_entity_id
missing_single_sign_on_url
Default: unknown_saml_status

Service Provider information.

entity_id
​string

Entity ID of the SAML Identity Provider.

single_sign_on_url
​string

Single Sign-On URL of the SAML Identity Provider.

srn
​string

The SRN of the SAML.

Enable SAML Identity Provider for an Organization

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

Enable SAML Identity Provider for an Organization › path Parameters

organization_id
​string · required

ID of the Organization.

Enable SAML Identity Provider for an Organization › Request Body

Enable SAML Identity Provider for an Organization › Responses

200
scaleway.iam.v1alpha1.Saml
id
​string

ID of the SAML configuration.

status
​scaleway.iam.v1alpha1.Saml.Status · enum

Status of the SAML configuration.

Enum values:
unknown_saml_status
valid
missing_certificate
missing_entity_id
missing_single_sign_on_url
Default: unknown_saml_status

Service Provider information.

entity_id
​string

Entity ID of the SAML Identity Provider.

single_sign_on_url
​string

Single Sign-On URL of the SAML Identity Provider.

srn
​string

The SRN of the SAML.

Get a SAML certificate

GET
https://api.scaleway.com
/iam/v1alpha1/saml-certificates/{certificate_id}

Get a SAML certificate › path Parameters

certificate_id
​string · required

ID of the certificate to get.

Get a SAML certificate › Responses

200
scaleway.iam.v1alpha1.SamlCertificate
id
​string

ID of the SAML certificate.

type
​scaleway.iam.v1alpha1.SamlCertificate.Type · enum

Type of the SAML certificate.

Enum values:
unknown_certificate_type
signing
encryption
Default: unknown_certificate_type
origin
​scaleway.iam.v1alpha1.SamlCertificate.Origin · enum

Origin of the SAML certificate.

Enum values:
unknown_certificate_origin
scaleway
identity_provider
Default: unknown_certificate_origin
content
​string

Content of the SAML certificate.

expires_at
​string | null · date-time

Date and time of the SAML certificate expiration. (RFC 3339 format)

srn
​string

The SRN of the SAML certificate.

Delete a SAML certificate

DELETE
https://api.scaleway.com
/iam/v1alpha1/saml-certificates/{certificate_id}

Delete a SAML certificate › path Parameters

certificate_id
​string · required

ID of the certificate to delete.

Delete a SAML certificate › Responses

No data returned

Disable SAML Identity Provider for an Organization

DELETE
https://api.scaleway.com
/iam/v1alpha1/saml/{saml_id}

Disable SAML Identity Provider for an Organization › path Parameters

saml_id
​string · required

ID of the SAML configuration.

Disable SAML Identity Provider for an Organization › Responses

No data returned

Update SAML Identity Provider configuration

PATCH
https://api.scaleway.com
/iam/v1alpha1/saml/{saml_id}

Update SAML Identity Provider configuration › path Parameters

saml_id
​string · required

ID of the SAML configuration.

Update SAML Identity Provider configuration › Request Body

entity_id
​string | null

Entity ID of the SAML Identity Provider.

single_sign_on_url
​string | null

Single Sign-On URL of the SAML Identity Provider.

Update SAML Identity Provider configuration › Responses

200
scaleway.iam.v1alpha1.Saml
id
​string

ID of the SAML configuration.

status
​scaleway.iam.v1alpha1.Saml.Status · enum

Status of the SAML configuration.

Enum values:
unknown_saml_status
valid
missing_certificate
missing_entity_id
missing_single_sign_on_url
Default: unknown_saml_status

Service Provider information.

entity_id
​string

Entity ID of the SAML Identity Provider.

single_sign_on_url
​string

Single Sign-On URL of the SAML Identity Provider.

srn
​string

The SRN of the SAML.

List SAML certificates

GET
https://api.scaleway.com
/iam/v1alpha1/saml/{saml_id}/certificates

List SAML certificates › path Parameters

saml_id
​string · required

ID of the SAML configuration.

List SAML certificates › Responses

Add a SAML certificate

POST
https://api.scaleway.com
/iam/v1alpha1/saml/{saml_id}/certificates

Add a SAML certificate › path Parameters

saml_id
​string · required

ID of the SAML configuration.

Add a SAML certificate › Request Body

type
​scaleway.iam.v1alpha1.SamlCertificate.Type · enum · required

Type of the SAML certificate.

Enum values:
unknown_certificate_type
signing
encryption
Default: unknown_certificate_type
content
​string · required

Content of the SAML certificate.

Add a SAML certificate › Responses

200
scaleway.iam.v1alpha1.SamlCertificate
id
​string

ID of the SAML certificate.

type
​scaleway.iam.v1alpha1.SamlCertificate.Type · enum

Type of the SAML certificate.

Enum values:
unknown_certificate_type
signing
encryption
Default: unknown_certificate_type
origin
​scaleway.iam.v1alpha1.SamlCertificate.Origin · enum

Origin of the SAML certificate.

Enum values:
unknown_certificate_origin
scaleway
identity_provider
Default: unknown_certificate_origin
content
​string

Content of the SAML certificate.

expires_at
​string | null · date-time

Date and time of the SAML certificate expiration. (RFC 3339 format)

srn
​string

The SRN of the SAML certificate.

LogsSCIM