> ## 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.

# Preflight an SSO provider configuration

> Validates a candidate SSO configuration and WRITES NOTHING.

Call it before `PUT /v1/sso/provider`. The upsert is the call that can lock an organization out of its own login screen; this one costs nothing, so there is no reason to skip it.

The response is a report, not a yes/no: it names what it could and could not verify.

Failures:
- `400` — the candidate configuration is malformed enough that it cannot be checked at all.



## OpenAPI

````yaml /en/openapi/v3-current/AM-identity.yaml post /v1/sso/provider/preflight
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/preflight:
    post:
      tags:
        - SSO
      summary: Preflight an SSO provider configuration
      description: >-
        Validates a candidate SSO configuration and WRITES NOTHING.


        Call it before `PUT /v1/sso/provider`. The upsert is the call that can
        lock an organization out of its own login screen; this one costs
        nothing, so there is no reason to skip it.


        The response is a report, not a yes/no: it names what it could and could
        not verify.


        Failures:

        - `400` — the candidate configuration is malformed enough that it cannot
        be checked at all.
      operationId: preflightSSOProvider
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SSOProviderConfigInput'
              description: The candidate configuration to validate. Nothing is stored.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SSOProviderPreflight'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Bad Request
        '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
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '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:
    SSOProviderConfigInput:
      additionalProperties: false
      properties:
        clientId:
          type: string
        clientSecret:
          type: string
        customAuthUrl:
          type: string
        customTokenUrl:
          type: string
        customUserInfoUrl:
          type: string
        disablePasswordLogin:
          examples:
            - true
          type: boolean
        domain:
          examples:
            - https://your-org.okta.com
          type: string
        issuerUrl:
          type: string
        name:
          type: string
        scopes:
          type: string
        type:
          examples:
            - Google
          type: string
      required:
        - type
        - clientId
        - clientSecret
      type: object
    SSOProviderPreflight:
      additionalProperties: false
      properties:
        authorizationEndpoint:
          examples:
            - https://accounts.google.com/o/oauth2/v2/auth
          type: string
        configValid:
          type: boolean
        credentialsValid:
          type: boolean
        discoveryOk:
          type: boolean
        redirectUriAcceptedByIdp:
          type: boolean
        tokenEndpoint:
          examples:
            - https://oauth2.googleapis.com/token
          type: string
        userinfoEndpoint:
          examples:
            - https://openidconnect.googleapis.com/v1/userinfo
          type: string
      type: object
    HTTPError:
      additionalProperties: false
      properties:
        code:
          type: string
        entityType:
          type: string
        err: {}
        message:
          type: string
        title:
          type: string
      type: object
    Detail:
      additionalProperties: true
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          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.