Auth0
Auth0 connection-profiles API

The connection-profiles API from Auth0 — 4 operation(s) for connection-profiles.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.0
info:
  title: Auth0 Authentication actions connection-profiles 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: connection-profiles
paths:
  /connection-profiles:
    get:
      summary: Get Connection Profiles
      description: 'Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.

        '
      tags:
      - connection-profiles
      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 5.
        schema:
          type: integer
          minimum: 1
          maximum: 10
      responses:
        '200':
          description: Connection Profiles successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectionProfilesPaginatedResponseContent'
        '400':
          description: Invalid request query string. The message will vary depending on the cause.
          x-description-1: 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:connection_profiles.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_connection-profiles
      x-operation-name: list
      x-operation-request-parameters-name: ListConnectionProfileRequestParameters
      x-operation-group: connectionProfiles
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:connection_profiles
    post:
      summary: Create a Connection Profile
      description: 'Create a Connection Profile.

        '
      tags:
      - connection-profiles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionProfileRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateConnectionProfileRequestContent'
      responses:
        '201':
          description: Connection profile successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectionProfileResponseContent'
        '400':
          description: Invalid request body. 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: create:connection_profiles.'
        '409':
          description: Connection profile conflict.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: post_connection-profiles
      x-operation-name: create
      x-operation-group: connectionProfiles
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - create:connection_profiles
  /connection-profiles/templates:
    get:
      summary: Get Connection Profile Templates
      description: 'Retrieve a list of Connection Profile Templates.

        '
      tags:
      - connection-profiles
      responses:
        '200':
          description: Connection Profile Templates successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectionProfileTemplateResponseContent'
        '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:connection_profiles.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_connection_profile_templates
      x-operation-name: listTemplates
      x-operation-group: connectionProfiles
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:connection_profiles
  /connection-profiles/templates/{id}:
    get:
      summary: Get Connection Profile Template
      description: 'Retrieve a Connection Profile Template.

        '
      tags:
      - connection-profiles
      parameters:
      - name: id
        in: path
        description: ID of the connection-profile-template to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Connection Profile Template successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectionProfileTemplateResponseContent'
        '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:connection_profiles.'
        '404':
          description: Connection profile template not found.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_connection_profile_template
      x-operation-name: getTemplate
      x-operation-group: connectionProfiles
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:connection_profiles
  /connection-profiles/{id}:
    get:
      summary: Get Connection Profile
      description: 'Retrieve details about a single Connection Profile specified by ID.

        '
      tags:
      - connection-profiles
      parameters:
      - name: id
        in: path
        description: ID of the connection-profile to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Record for existing connection profile.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConnectionProfileResponseContent'
        '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:connection-profiles.'
        '404':
          description: Connection profile not found.
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: get_connection-profiles_by_id
      x-operation-name: get
      x-operation-group: connectionProfiles
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - read:connection_profiles
    delete:
      summary: Delete Connection Profile
      description: 'Delete a single Connection Profile specified by ID.

        '
      tags:
      - connection-profiles
      parameters:
      - name: id
        in: path
        description: ID of the connection-profile to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Connection profile successfully deleted.
        '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: delete:connection-profiles.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: delete_connection-profiles_by_id
      x-operation-name: delete
      x-operation-group: connectionProfiles
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - delete:connection_profiles
    patch:
      summary: Modify a Connection Profile
      description: 'Update the details of a specific Connection Profile.

        '
      tags:
      - connection-profiles
      parameters:
      - name: id
        in: path
        description: ID of the connection profile to update.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectionProfileRequestContent'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateConnectionProfileRequestContent'
      responses:
        '200':
          description: Connection profile successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConnectionProfileResponseContent'
        '400':
          description: Invalid request body. 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: update:connection_profiles.'
        '429':
          description: Too many requests. Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.
      operationId: patch_connection-profiles_by_id
      x-operation-name: update
      x-operation-group: connectionProfiles
      security:
      - bearerAuth: []
      - oAuth2ClientCredentials:
        - update:connection_profiles
components:
  schemas:
    ConnectionProfileOrganizationShowAsButtonEnum:
      type: string
      description: Indicates if the organization should be shown as a button.
      enum:
      - none
      - optional
      - required
    UpdateConnectionProfileResponseContent:
      type: object
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/ConnectionProfileId'
        name:
          $ref: '#/components/schemas/ConnectionProfileName'
        organization:
          $ref: '#/components/schemas/ConnectionProfileOrganization'
        connection_name_prefix_template:
          $ref: '#/components/schemas/ConnectionNamePrefixTemplate'
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileConfig'
        strategy_overrides:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverrides'
    ConnectionProfileStrategyOverride:
      type: object
      description: Connection Profile Strategy Override
      additionalProperties: false
      properties:
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverridesEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverridesConnectionConfig'
    UpdateConnectionProfileRequestContent:
      type: object
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/ConnectionProfileName'
        organization:
          $ref: '#/components/schemas/ConnectionProfileOrganization'
        connection_name_prefix_template:
          $ref: '#/components/schemas/ConnectionNamePrefixTemplate'
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileConfig'
        strategy_overrides:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverrides'
    CreateConnectionProfileResponseContent:
      type: object
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/ConnectionProfileId'
        name:
          $ref: '#/components/schemas/ConnectionProfileName'
        organization:
          $ref: '#/components/schemas/ConnectionProfileOrganization'
        connection_name_prefix_template:
          $ref: '#/components/schemas/ConnectionNamePrefixTemplate'
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileConfig'
        strategy_overrides:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverrides'
    ListConnectionProfilesPaginatedResponseContent:
      type: object
      additionalProperties: false
      properties:
        next:
          type: string
          description: A cursor to be used as the "from" query parameter for the next page of results.
        connection_profiles:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionProfile'
    ConnectionProfileStrategyOverrides:
      type: object
      description: Strategy-specific overrides for this attribute
      additionalProperties: false
      properties:
        pingfederate:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
        ad:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
        adfs:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
        waad:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
        google-apps:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
        okta:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
        oidc:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
        samlp:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverride'
    GetConnectionProfileResponseContent:
      type: object
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/ConnectionProfileId'
        name:
          $ref: '#/components/schemas/ConnectionProfileName'
        organization:
          $ref: '#/components/schemas/ConnectionProfileOrganization'
        connection_name_prefix_template:
          $ref: '#/components/schemas/ConnectionNamePrefixTemplate'
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileConfig'
        strategy_overrides:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverrides'
    ConnectionProfileOrganizationAssignMembershipOnLoginEnum:
      type: string
      description: Indicates if membership should be assigned on login.
      enum:
      - none
      - optional
      - required
    ConnectionProfileOrganization:
      type: object
      description: The organization of the connection profile.
      additionalProperties: false
      properties:
        show_as_button:
          $ref: '#/components/schemas/ConnectionProfileOrganizationShowAsButtonEnum'
        assign_membership_on_login:
          $ref: '#/components/schemas/ConnectionProfileOrganizationAssignMembershipOnLoginEnum'
    ConnectionProfileEnabledFeatures:
      type: array
      description: Enabled features for the connection profile.
      items:
        $ref: '#/components/schemas/EnabledFeaturesEnum'
    ConnectionProfileConfig:
      type: object
      description: Connection profile configuration.
      additionalProperties: false
      properties: {}
    CreateConnectionProfileRequestContent:
      type: object
      additionalProperties: false
      required:
      - name
      properties:
        name:
          $ref: '#/components/schemas/ConnectionProfileName'
        organization:
          $ref: '#/components/schemas/ConnectionProfileOrganization'
        connection_name_prefix_template:
          $ref: '#/components/schemas/ConnectionNamePrefixTemplate'
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileConfig'
        strategy_overrides:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverrides'
    ConnectionProfile:
      type: object
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/ConnectionProfileId'
        name:
          $ref: '#/components/schemas/ConnectionProfileName'
        organization:
          $ref: '#/components/schemas/ConnectionProfileOrganization'
        connection_name_prefix_template:
          $ref: '#/components/schemas/ConnectionNamePrefixTemplate'
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileConfig'
        strategy_overrides:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverrides'
    ConnectionProfileTemplateItem:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: The id of the template.
        display_name:
          type: string
          description: The user-friendly name of the template displayed in the UI.
        template:
          $ref: '#/components/schemas/ConnectionProfileTemplate'
    GetConnectionProfileTemplateResponseContent:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: The id of the template.
        display_name:
          type: string
          description: The user-friendly name of the template displayed in the UI.
        template:
          $ref: '#/components/schemas/ConnectionProfileTemplate'
    ConnectionProfileId:
      type: string
      description: Connection Profile identifier.
      format: connection-profile-id
    EnabledFeaturesEnum:
      type: string
      description: Enum for enabled features.
      enum:
      - scim
      - universal_logout
    ConnectionProfileTemplate:
      type: object
      description: The structure of the template, which can be used as the payload for creating or updating a Connection Profile.
      additionalProperties: false
      properties:
        name:
          $ref: '#/components/schemas/ConnectionProfileName'
        organization:
          $ref: '#/components/schemas/ConnectionProfileOrganization'
        connection_name_prefix_template:
          $ref: '#/components/schemas/ConnectionNamePrefixTemplate'
        enabled_features:
          $ref: '#/components/schemas/ConnectionProfileEnabledFeatures'
        connection_config:
          $ref: '#/components/schemas/ConnectionProfileConfig'
        strategy_overrides:
          $ref: '#/components/schemas/ConnectionProfileStrategyOverrides'
    ConnectionProfileName:
      type: string
      description: The name of the connection profile.
      minLength: 1
      maxLength: 50
    ConnectionProfileStrategyOverridesConnectionConfig:
      type: object
      description: Connection profile strategy overrides connection configuration.
      additionalProperties: false
      properties: {}
    ConnectionProfileStrategyOverridesEnabledFeatures:
      type: array
      description: Enabled features for a connections profile strategy override.
      items:
        $ref: '#/components/schemas/EnabledFeaturesEnum'
    ListConnectionProfileTemplateResponseContent:
      type: object
      additionalProperties: false
      properties:
        connection_profile_templates:
          type: array
          items:
            $ref: '#/components/schemas/ConnectionProfileTemplateItem'
    ConnectionNamePrefixTemplate:
      type: string
      description: Connection name prefix template.
      minLength: 0
      maxLength: 15
      pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$
Auth0 connection-profiles API

Documentation

Specifications

Other Resources

OpenAPI Specification
