Scaleway

Scaleway SAML API

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.

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 8

GET /iam/v1alpha1/organizations/{organization_id}/saml Get SAML Identity Provider configuration of an Organization #

POST /iam/v1alpha1/organizations/{organization_id}/saml Enable SAML Identity Provider for an Organization #

GET /iam/v1alpha1/saml-certificates/{certificate_id} Get a SAML certificate #

DELETE /iam/v1alpha1/saml-certificates/{certificate_id} Delete a SAML certificate #

PATCH /iam/v1alpha1/saml/{saml_id} Update SAML Identity Provider configuration #

DELETE /iam/v1alpha1/saml/{saml_id} Disable SAML Identity Provider for an Organization #

GET /iam/v1alpha1/saml/{saml_id}/certificates List SAML certificates #

POST /iam/v1alpha1/saml/{saml_id}/certificates Add a SAML certificate #

Documentation

📖

Documentation

https://www.scaleway.com/en/developers/api/instances/

📖

Documentation

https://www.scaleway.com/en/developers/api/kubernetes/

📖

Documentation

https://www.scaleway.com/en/developers/api/iam/

📖

Documentation

https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/

📖

Documentation

https://www.scaleway.com/en/developers/api/managed-databases-for-postgresql-and-mysql/

📖

Documentation

https://www.scaleway.com/en/developers/api/vpc/

📖

Documentation

https://www.scaleway.com/en/developers/api/serverless-containers/

📖

Documentation

https://www.scaleway.com/en/developers/api/serverless-functions/

📖

Documentation

https://www.scaleway.com/en/developers/api/secret-manager/

📖

Documentation

https://www.scaleway.com/en/developers/api/transactional-email/

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/scaleway/refs/heads/main/openapi/scaleway-saml-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/scaleway-saml-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: IAM SAML API
  description: Identity and Access Management (IAM) allows you to share access to the management of your Scaleway resources and Organization settings, in a controlled and secure manner.
  version: v1alpha1
servers:
- url: https://api.scaleway.com
tags:
- name: SAML
  description: 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.
paths:
  /iam/v1alpha1/organizations/{organization_id}/saml:
    get:
      tags:
      - SAML
      operationId: GetOrganizationSaml
      summary: Get SAML Identity Provider configuration of an Organization
      parameters:
      - in: path
        name: organization_id
        description: ID of the Organization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.iam.v1alpha1.Saml'
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X GET \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  \"https://api.scaleway.com/iam/v1alpha1/organizations/{organization_id}/saml\""
      - lang: HTTPie
        source: "http GET \"https://api.scaleway.com/iam/v1alpha1/organizations/{organization_id}/saml\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
    post:
      tags:
      - SAML
      operationId: EnableOrganizationSaml
      summary: Enable SAML Identity Provider for an Organization
      parameters:
      - in: path
        name: organization_id
        description: ID of the Organization.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.iam.v1alpha1.Saml'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X POST \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{}' \\\n  \"https://api.scaleway.com/iam/v1alpha1/organizations/{organization_id}/saml\""
      - lang: HTTPie
        source: "http POST \"https://api.scaleway.com/iam/v1alpha1/organizations/{organization_id}/saml\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
  /iam/v1alpha1/saml-certificates/{certificate_id}:
    get:
      tags:
      - SAML
      operationId: GetSamlCertificate
      summary: Get a SAML certificate
      parameters:
      - in: path
        name: certificate_id
        description: ID of the certificate to get.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.iam.v1alpha1.SamlCertificate'
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X GET \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  \"https://api.scaleway.com/iam/v1alpha1/saml-certificates/{certificate_id}\""
      - lang: HTTPie
        source: "http GET \"https://api.scaleway.com/iam/v1alpha1/saml-certificates/{certificate_id}\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
    delete:
      tags:
      - SAML
      operationId: DeleteSamlCertificate
      summary: Delete a SAML certificate
      parameters:
      - in: path
        name: certificate_id
        description: ID of the certificate to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X DELETE \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  \"https://api.scaleway.com/iam/v1alpha1/saml-certificates/{certificate_id}\""
      - lang: HTTPie
        source: "http DELETE \"https://api.scaleway.com/iam/v1alpha1/saml-certificates/{certificate_id}\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
  /iam/v1alpha1/saml/{saml_id}:
    patch:
      tags:
      - SAML
      operationId: UpdateSaml
      summary: Update SAML Identity Provider configuration
      parameters:
      - in: path
        name: saml_id
        description: ID of the SAML configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.iam.v1alpha1.Saml'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_id:
                  type: string
                  description: Entity ID of the SAML Identity Provider.
                single_sign_on_url:
                  type: string
                  description: Single Sign-On URL of the SAML Identity Provider.
              x-properties-order:
              - entity_id
              - single_sign_on_url
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X PATCH \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{}' \\\n  \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}\""
      - lang: HTTPie
        source: "http PATCH \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
    delete:
      tags:
      - SAML
      operationId: DeleteSaml
      summary: Disable SAML Identity Provider for an Organization
      parameters:
      - in: path
        name: saml_id
        description: ID of the SAML configuration.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X DELETE \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}\""
      - lang: HTTPie
        source: "http DELETE \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
  /iam/v1alpha1/saml/{saml_id}/certificates:
    get:
      tags:
      - SAML
      operationId: ListSamlCertificates
      summary: List SAML certificates
      parameters:
      - in: path
        name: saml_id
        description: ID of the SAML configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.iam.v1alpha1.ListSamlCertificatesResponse'
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X GET \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}/certificates\""
      - lang: HTTPie
        source: "http GET \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}/certificates\" \\\n  X-Auth-Token:$SCW_SECRET_KEY"
    post:
      tags:
      - SAML
      operationId: AddSamlCertificate
      summary: Add a SAML certificate
      parameters:
      - in: path
        name: saml_id
        description: ID of the SAML configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scaleway.iam.v1alpha1.SamlCertificate'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: Type of the SAML certificate.
                  enum:
                  - unknown_certificate_type
                  - signing
                  - encryption
                  x-enum-descriptions:
                    values:
                      unknown_certificate_type: Unknown certificate type
                      signing: Signing certificate
                      encryption: Encryption certificate
                  default: unknown_certificate_type
                content:
                  type: string
                  description: Content of the SAML certificate.
              required:
              - type
              - content
              x-properties-order:
              - type
              - content
      security:
      - scaleway: []
      x-codeSamples:
      - lang: cURL
        source: "curl -X POST \\\n  -H \"X-Auth-Token: $SCW_SECRET_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"content\":\"string\",\"type\":\"unknown_certificate_type\"}' \\\n  \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}/certificates\""
      - lang: HTTPie
        source: "http POST \"https://api.scaleway.com/iam/v1alpha1/saml/{saml_id}/certificates\" \\\n  X-Auth-Token:$SCW_SECRET_KEY \\\n  content=\"string\" \\\n  type=\"unknown_certificate_type\""
components:
  schemas:
    scaleway.iam.v1alpha1.Saml:
      type: object
      properties:
        id:
          type: string
          description: ID of the SAML configuration.
        status:
          type: string
          description: Status of the SAML configuration.
          enum:
          - unknown_saml_status
          - valid
          - missing_certificate
          - missing_entity_id
          - missing_single_sign_on_url
          default: unknown_saml_status
        service_provider:
          type: object
          description: Service Provider information.
          properties:
            entity_id:
              type: string
            assertion_consumer_service_url:
              type: string
          x-properties-order:
          - entity_id
          - assertion_consumer_service_url
        entity_id:
          type: string
          description: Entity ID of the SAML Identity Provider.
        single_sign_on_url:
          type: string
          description: Single Sign-On URL of the SAML Identity Provider.
      x-properties-order:
      - id
      - status
      - service_provider
      - entity_id
      - single_sign_on_url
    scaleway.iam.v1alpha1.SamlCertificate:
      type: object
      properties:
        id:
          type: string
          description: ID of the SAML certificate.
        type:
          type: string
          description: Type of the SAML certificate.
          enum:
          - unknown_certificate_type
          - signing
          - encryption
          x-enum-descriptions:
            values:
              unknown_certificate_type: Unknown certificate type
              signing: Signing certificate
              encryption: Encryption certificate
          default: unknown_certificate_type
        origin:
          type: string
          description: Origin of the SAML certificate.
          enum:
          - unknown_certificate_origin
          - scaleway
          - identity_provider
          x-enum-descriptions:
            values:
              unknown_certificate_origin: Unknown certificate origin
              scaleway: Certificate from Scaleway
              identity_provider: Certificate from Identity Provider
          default: unknown_certificate_origin
        content:
          type: string
          description: Content of the SAML certificate.
        expires_at:
          type: string
          description: Date and time of the SAML certificate expiration. (RFC 3339 format)
          format: date-time
          example: '2022-03-22T12:34:56.123456Z'
          nullable: true
      x-properties-order:
      - id
      - type
      - origin
      - content
      - expires_at
    scaleway.iam.v1alpha1.ListSamlCertificatesResponse:
      type: object
      properties:
        certificates:
          type: array
          description: List of SAML certificates.
          items:
            $ref: '#/components/schemas/scaleway.iam.v1alpha1.SamlCertificate'
      x-properties-order:
      - certificates
  securitySchemes:
    scaleway:
      in: header
      name: X-Auth-Token
      type: apiKey