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

# Get SSO provider configuration

> Returns your organization's SSO provider configuration — the identity provider your people sign in through.

A tenant has AT MOST ONE active OAuth provider, so this route needs no id: it reads the one belonging to the organization resolved from your token, and cannot be pointed at another tenant's. It is a composed view over the generic `/v1/providers` catalog, which is still where Email and SMS providers are managed.

Read-only: nothing changes.

Failures:
- `503 IDE-0066` — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.



## OpenAPI

````yaml /en/openapi/v3-current/AM-identity.yaml get /v1/sso/provider
openapi: 3.1.0
info:
  contact:
    name: Lerian Studio
    url: https://lerian.studio
  description: OpenAPI 3.1 surface for the Access Manager identity component.
  license:
    name: Lerian Studio General License
  title: Plugin Access Manager — Identity API
  version: v1
servers:
  - url: https://identity.sandbox.lerian.net
security: []
tags:
  - description: >-
      M2M-only: each plugin declares its own permissions, roles and M2M
      contract, and the server reconciles them.
    name: Declarations
  - description: >-
      A tenant administrator's customers. Each partner holds what its
      credentials may DO (permissions, per product) and WHERE they may do it
      (scope, per product and dimension); an M2M application attached to one is
      confined to that intersection. Administrator-only: authorized on the
      "partners" resource, and every route resolves the owning organization from
      the caller's token.
    name: Partners
paths:
  /v1/sso/provider:
    get:
      tags:
        - SSO
      summary: Get SSO provider configuration
      description: >-
        Returns your organization's SSO provider configuration — the identity
        provider your people sign in through.


        A tenant has AT MOST ONE active OAuth provider, so this route needs no
        id: it reads the one belonging to the organization resolved from your
        token, and cannot be pointed at another tenant's. It is a composed view
        over the generic `/v1/providers` catalog, which is still where Email and
        SMS providers are managed.


        Read-only: nothing changes.


        Failures:

        - `503 IDE-0066` — the identity provider is unavailable (unreachable,
        too slow to answer, or failing). Nothing about the request was wrong;
        retry it later.
      operationId: getSSOProvider
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SSOProviderConfigResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Service Unavailable
      security:
        - BearerAuth: []
components:
  schemas:
    SSOProviderConfigResponse:
      additionalProperties: false
      properties:
        configured:
          type: boolean
        passwordEnabled:
          type: boolean
        provider:
          $ref: '#/components/schemas/ProviderResponse'
      type: object
    HTTPError:
      additionalProperties: false
      properties:
        code:
          type: string
        entityType:
          type: string
        err: {}
        message:
          type: string
        title:
          type: string
      type: object
    ProviderResponse:
      additionalProperties: false
      properties:
        appId:
          type: string
        category:
          enum:
            - Email
            - SMS
            - OAuth
          examples:
            - Email
          type: string
        clientId:
          type: string
        clientId2:
          type: string
        content:
          type: string
        createdAt:
          examples:
            - '2021-09-01T00:00:00Z'
          type: string
        customAuthUrl:
          type: string
        customTokenUrl:
          type: string
        customUserInfoUrl:
          type: string
        disableSsl:
          type: boolean
        domain:
          type: string
        endpoint:
          type: string
        host:
          type: string
        id:
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        intranetEndpoint:
          type: string
        issuerUrl:
          type: string
        method:
          type: string
        name:
          examples:
            - SMTP Corp
          type: string
        port:
          format: int64
          type: integer
        providerUrl:
          type: string
        receiver:
          type: string
        regionId:
          type: string
        scopes:
          type: string
        signName:
          type: string
        subType:
          type: string
        templateCode:
          type: string
        title:
          type: string
        type:
          enum:
            - SendGrid
            - Twilio SMS
            - Twilio
            - Google
            - Microsoft
            - Okta
            - Custom
          examples:
            - SendGrid
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.