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

# Get the SAML SSO configuration

> The service provider private key is never returned



## OpenAPI

````yaml https://openapi.production.reelevant.io/v1/render/entity-manager get /sso/config
openapi: 3.0.0
info:
  title: entity-manager
  version: unknown
  description: |-
    # Errors
    | Error code | Message | HTTP status code | Payload |
    | :--- | :--- | :--- | :--- |
    | number | string | 400 |  |
servers:
  - url: https://api.reelevant.com/v2/
    description: production
security: []
paths:
  /sso/config:
    get:
      tags:
        - SSO
      summary: Get the SAML SSO configuration
      description: The service provider private key is never returned
      operationId: get-sso-config
      parameters: []
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - success
                    required:
                      - status
                    additionalProperties: false
                  - $ref: >-
                      #/components/schemas/InternalResponse_SerializedSSOConfiguration
        '404':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/InternalResponse_'
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - fail
                      error_code:
                        type: number
                      code:
                        type: number
                      message:
                        type: string
                      data:
                        oneOf:
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              count:
                                type: number
                            required:
                              - count
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              resources:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    resources:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          id:
                                            type: string
                                        required:
                                          - id
                                        additionalProperties: false
                                  required:
                                    - name
                                    - resources
                                  additionalProperties: false
                            required:
                              - resources
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              usedAt:
                                type: string
                                format: date-time
                            required:
                              - usedAt
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              reason:
                                type: string
                            required:
                              - reason
                            additionalProperties: false
                          - type: object
                            properties:
                              domains:
                                type: array
                                items:
                                  type: string
                            required:
                              - domains
                            additionalProperties: false
                          - type: object
                            properties:
                              domain:
                                type: string
                            required:
                              - domain
                            additionalProperties: false
                          - type: object
                            properties:
                              reason:
                                oneOf:
                                  - type: string
                                    enum:
                                      - incomplete
                                  - type: string
                                    enum:
                                      - never-used
                            required:
                              - reason
                            additionalProperties: false
                          - type: object
                            properties:
                              properties:
                                type: array
                                items:
                                  type: string
                            required:
                              - properties
                            additionalProperties: false
                    required:
                      - status
                      - error_code
                      - code
                      - message
                    additionalProperties: false
      security:
        - password_auth: []
components:
  schemas:
    InternalResponse_SerializedSSOConfiguration:
      type: object
      properties:
        program:
          type: string
        version:
          type: string
        datetime:
          type: string
        status:
          type: string
        code:
          type: number
        message:
          type: string
        data:
          $ref: '#/components/schemas/SerializedSSOConfiguration'
      required:
        - program
        - version
        - datetime
        - status
        - message
        - data
      additionalProperties: false
    InternalResponse_:
      type: object
      properties:
        program:
          type: string
        version:
          type: string
        datetime:
          type: string
        status:
          type: string
        code:
          type: number
        message:
          type: string
        data:
          type: object
          properties: {}
          additionalProperties: false
      required:
        - program
        - version
        - datetime
        - status
        - message
        - data
      additionalProperties: false
    SerializedSSOConfiguration:
      type: object
      properties:
        configured:
          type: boolean
          description: >-
            False when the company has no SSO configuration yet, the other
            fields then hold defaults
        domains:
          type: array
          items:
            type: string
        metadata:
          type: string
          description: Identity provider SAML metadata (XML), public by nature
        identityProviderEntityId:
          type: string
          description: Entity id advertised by the identity provider metadata
        propertyLookup:
          type: object
          properties: {}
          additionalProperties:
            type: array
            items:
              type: string
        mode:
          oneOf:
            - type: string
              enum:
                - invitation
            - type: string
              enum:
                - create
        mandatory:
          type: boolean
        lastLoginAt:
          type: string
          format: date-time
          description: >-
            Last successful login through this configuration, required before it
            can be enforced
        serviceProvider:
          allOf:
            - $ref: '#/components/schemas/ServiceProviderDetails'
          description: What the customer has to declare in its identity provider
      required:
        - configured
        - domains
        - metadata
        - propertyLookup
        - mode
        - mandatory
        - serviceProvider
      additionalProperties: false
    ServiceProviderDetails:
      type: object
      properties:
        entityId:
          type: string
          description: >-
            Entity id (a.k.a. audience / issuer) to declare in the identity
            provider
        callbackUrl:
          type: string
          description: Where the identity provider must post its assertions (ACS URL)
        loginUrls:
          type: array
          items:
            type: object
            properties:
              domain:
                type: string
              url:
                type: string
            required:
              - domain
              - url
            additionalProperties: false
          description: >-
            Where users start a login for a given domain, one per configured
            domain
        metadataUrl:
          type: string
          description: URL serving the service provider SAML metadata
        certificate:
          type: string
          description: Public certificate of the service provider, PEM encoded
      required:
        - entityId
        - callbackUrl
        - loginUrls
        - metadataUrl
        - certificate
      additionalProperties: false
  securitySchemes:
    password_auth:
      type: oauth2
      flows:
        password:
          tokenUrl: https://api.reelevant.com/v1/auth/token
          refreshUrl: https://api.reelevant.com/v1/auth/token
          scopes: {}

````