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

# Get Idp Connection

> Get the current IdP connection configuration for the organization.

Returns the current OIDC configuration including endpoints and
whether client credentials are configured (credentials are not exposed).

Only admins can view this configuration.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/identity/public/v1/idp/connection
openapi: 3.1.0
info:
  title: Barndoor.ai Public API
  description: Unified public API specification for Barndoor.ai platform
  version: 2.18.0
servers:
  - url: https://{host}
    description: Barndoor public API
    variables:
      host:
        default: platform.barndoor.ai
        description: >-
          The host serving your Barndoor deployment. Defaults to production;
          override it for another environment or a dedicated deployment.
security:
  - ApiKey: []
  - OAuth2:
      - openid
      - profile
      - email
tags:
  - name: dlp
    x-group: Data Control Center
  - name: identity
    x-group: Identity
  - name: llm-gateway
    x-group: LLM Gateway
  - name: notification
    x-group: Notifications
  - name: policy
    x-group: Policies
  - name: registry
    x-group: MCP Gateway
  - name: system-management
    x-group: Log Exports
paths:
  /api/identity/public/v1/idp/connection:
    get:
      tags:
        - identity
      summary: Get Idp Connection
      description: |-
        Get the current IdP connection configuration for the organization.

        Returns the current OIDC configuration including endpoints and
        whether client credentials are configured (credentials are not exposed).

        Only admins can view this configuration.
      operationId: get_idp_connection
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdpConnectionResponse'
components:
  schemas:
    IdpConnectionResponse:
      properties:
        configured:
          type: boolean
          title: Configured
          default: false
        alias:
          anyOf:
            - type: string
            - type: 'null'
          title: Alias
        expected_alias:
          anyOf:
            - type: string
            - type: 'null'
          title: Expected Alias
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        issuer:
          anyOf:
            - type: string
            - type: 'null'
          title: Issuer
        authorization_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Authorization Url
        token_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Token Url
        userinfo_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Userinfo Url
        jwks_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Jwks Url
        logout_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Logout Url
        scopes:
          anyOf:
            - type: string
            - type: 'null'
          title: Scopes
        prompt:
          type: string
          title: Prompt
          default: ''
        client_id_configured:
          type: boolean
          title: Client Id Configured
          default: false
        client_secret_configured:
          type: boolean
          title: Client Secret Configured
          default: false
        domain:
          anyOf:
            - type: string
            - type: 'null'
          title: Domain
        domains:
          items:
            type: string
          type: array
          title: Domains
          default: []
      type: object
      title: IdpConnectionResponse
      description: Response containing current IdP connection configuration.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        A Barndoor API key, sent as `Authorization: Bearer <key>`. Keys are
        prefixed `bdai_` and are opaque — do not attempt to decode one.
        Interchangeable with an OAuth 2.0 access token.
    OAuth2:
      type: oauth2
      x-issuer: https://auth.barndoor.ai/realms/barndoor
      description: >-
        An OAuth 2.0 access token from Barndoor's identity provider, sent as
        `Authorization: Bearer <token>`. Public clients must use PKCE.
        Interchangeable with an API key.
      flows:
        authorizationCode:
          authorizationUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/auth
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.
        clientCredentials:
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.

````

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