> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get known provider presets

> Returns all pre-baked provider presets, including Okta, Entra ID, and Auth0.



## OpenAPI

````yaml get /api/identity-providers/presets
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/identity-providers/presets:
    get:
      tags:
        - Identity providers
      summary: Get known provider presets
      description: >-
        Returns all pre-baked provider presets, including Okta, Entra ID, and
        Auth0.
      operationId: get_presets_api_identity_providers_presets_get
      responses:
        '200':
          description: Known provider presets with default mappings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KnownProviderPresetsResponse'
        '403':
          description: Forbidden
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    KnownProviderPresetsResponse:
      properties:
        presets:
          items:
            $ref: '#/components/schemas/KnownProviderPreset'
          type: array
          title: Presets
        redirect_uri_template:
          type: string
          title: Redirect Uri Template
      type: object
      required:
        - presets
        - redirect_uri_template
      title: KnownProviderPresetsResponse
      description: All available known provider presets.
    KnownProviderPreset:
      properties:
        id:
          type: string
          title: Id
        display_name:
          type: string
          title: Display Name
        protocol:
          $ref: '#/components/schemas/IdpProtocol'
        description:
          type: string
          title: Description
        issuer_pattern:
          anyOf:
            - type: string
            - type: 'null'
          title: Issuer Pattern
        discovery_url_pattern:
          anyOf:
            - type: string
            - type: 'null'
          title: Discovery Url Pattern
        default_scopes:
          anyOf:
            - type: string
            - type: 'null'
          title: Default Scopes
        groups_claim:
          anyOf:
            - type: string
            - type: 'null'
          title: Groups Claim
        default_mappers:
          items:
            $ref: '#/components/schemas/IdpMapperConfig'
          type: array
          title: Default Mappers
        setup_instructions:
          anyOf:
            - type: string
            - type: 'null'
          title: Setup Instructions
      type: object
      required:
        - id
        - display_name
        - protocol
        - description
      title: KnownProviderPreset
      description: A pre-baked provider preset with defaults.
    IdpProtocol:
      type: string
      enum:
        - oidc
        - saml
        - ldap
      title: IdpProtocol
    IdpMapperConfig:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
          description: Mapper ID. It's set by Keycloak and omits on create.
        name:
          type: string
          title: Name
          description: Mapper name. For example, `email-mapper`.
        identity_provider_mapper:
          type: string
          title: Identity Provider Mapper
          description: >-
            Mapper type. For example, `oidc-user-attribute-idp-mapper` or
            `saml-user-attribute-idp-mapper`.
        config:
          additionalProperties: true
          type: object
          title: Config
          description: >-
            Mapper config. It's keys vary by mapper types, such as `syncMode`,
            `claim`, or `user.attribute`.
      type: object
      required:
        - name
        - identity_provider_mapper
      title: IdpMapperConfig
      description: A single IdP mapper for claim or attribute mapping.
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````