openapi: 3.0.0
info:
  title: Auth0 Authentication actions connections-scim-configurations API
  description: Auth0 Authentication API. Endpoints for authentication and authorization using OpenID Connect, OAuth 2.0, SAML, WS-Federation, and Passwordless flows.
  version: 1.0.0
servers:
- url: '{auth0_domain}'
  description: The Authentication API is served over HTTPS.
  variables:
    auth0_domain:
      description: Auth0 domain
      default: https://demo.us.auth0.com
tags:
- name: connections-scim-configurations
paths:
  /connections-scim-configurations:
    get:
      summary: Get a List of SCIM Configurations
      description: 'Retrieve a list of SCIM configurations of a tenant.

        '
      tags:
      - connections-scim-configurations
      parameters:
      - name: from
        in: query
        description: Optional Id from which to start selection.
        schema:
          type: string
      - name: take
        in: query
        description: Number of results per page. Defaults to 50.
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: The tenant's SCIM configurations. See <strong>Response Schema</strong> for schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSCIMConfigurationsResponseContent'
        '400':
          description: Invalid pagination cursor.
          x-description-1: Invalid request query string. The message will vary depending on the cause.
          x-description-2: Invalid query string paging options. The message will vary depending on the cause
        '401':
          description: Invalid token.
          x-description-1: Invalid signature received for JSON Web Token validation.
          x-description-2: Client is not global.
        '403':
          description: 'Insufficient scope; expected any of: read:scim_config.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_connections-scim-configurations
      x-release-lifecycle: GA
      x-operation-name: list
      x-operation-request-parameters-name: ListSCIMConfigurationsRequestParameters
      x-operation-group:
      - connections
      - scimConfiguration
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:scim_config
components:
  schemas:
    ScimMappingItem:
      type: object
      additionalProperties: true
      properties:
        auth0:
          type: string
          description: The field location in the auth0 schema
        scim:
          type: string
          description: The field location in the SCIM schema
    ScimConfiguration:
      type: object
      additionalProperties: false
      required:
      - tenant_name
      - connection_id
      - connection_name
      - strategy
      - created_at
      - updated_on
      - mapping
      - user_id_attribute
      properties:
        connection_id:
          type: string
          description: The connection's identifier
        connection_name:
          type: string
          description: The connection's name
        strategy:
          type: string
          description: The connection's strategy
        tenant_name:
          type: string
          description: The tenant's name
        user_id_attribute:
          type: string
          description: User ID attribute for generating unique user ids
        mapping:
          type: array
          description: The mapping between auth0 and SCIM
          items:
            $ref: '#/components/schemas/ScimMappingItem'
        created_at:
          type: string
          description: The ISO 8601 date and time the SCIM configuration was created at
          format: date-time
        updated_on:
          type: string
          description: The ISO 8601 date and time the SCIM configuration was last updated on
          format: date-time
    ListSCIMConfigurationsResponseContent:
      type: object
      additionalProperties: false
      required:
      - scim_configurations
      properties:
        scim_configurations:
          type: array
          description: List of SCIM configurations
          items:
            $ref: '#/components/schemas/ScimConfiguration'
        next:
          type: string
          description: The cursor to be used as the "from" query parameter for the next page of results.