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

# Update passkey policy

> Turns passkey sign-in on or off for your organization. Sending the value already stored changes nothing.

The option belongs to the organization resolved from your token; nothing in the request names another one. Passkeys and SSO exclude each other: passkeys cannot be turned on while an SSO provider is active, and an SSO provider cannot be configured while passkeys are on.

While passkeys are on, a person who has a passkey cannot sign in with a password (403 AUT-1019 on the password grant); everyone else signs in with password and second factor as before. Turning passkeys off lets everyone sign in with a password again; passkeys stay stored.

Failures:
- `400` — the body is malformed, or `enabled` is missing.
- `404` — the application backing your organization's login was not found.
- `409 IDE-1068` — an SSO provider is active; remove it before turning passkeys on.
- `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 patch /v1/passkey/policy
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/passkey/policy:
    patch:
      tags:
        - Passkey
      summary: Update passkey policy
      description: >-
        Turns passkey sign-in on or off for your organization. Sending the value
        already stored changes nothing.


        The option belongs to the organization resolved from your token; nothing
        in the request names another one. Passkeys and SSO exclude each other:
        passkeys cannot be turned on while an SSO provider is active, and an SSO
        provider cannot be configured while passkeys are on.


        While passkeys are on, a person who has a passkey cannot sign in with a
        password (403 AUT-1019 on the password grant); everyone else signs in
        with password and second factor as before. Turning passkeys off lets
        everyone sign in with a password again; passkeys stay stored.


        Failures:

        - `400` — the body is malformed, or `enabled` is missing.

        - `404` — the application backing your organization's login was not
        found.

        - `409 IDE-1068` — an SSO provider is active; remove it before turning
        passkeys on.

        - `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: setPasskeyPolicy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasskeyPolicyInput'
              description: The passkey option for the caller's organization.
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasskeyPolicyResponse'
          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
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPError'
          description: Conflict
        '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:
    PasskeyPolicyInput:
      additionalProperties: false
      properties:
        enabled:
          description: >-
            True offers passkey sign-in to the organization; false stops
            offering it. Existing passkeys stay stored either way.
          examples:
            - true
          type: boolean
      required:
        - enabled
      type: object
    PasskeyPolicyResponse:
      additionalProperties: false
      properties:
        enabled:
          description: >-
            True when the organization offers passkey sign-in. While it is true,
            a person who has a passkey cannot sign in with a password.
          examples:
            - true
          type: boolean
        ssoActive:
          description: >-
            True when the organization signs in through an SSO provider.
            Passkeys cannot be turned on while it is true.
          examples:
            - false
          type: boolean
      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.