Clerk Frontend Api — Sign Ins

naftiko: 1.0.0-alpha2
info:
  label: Clerk Frontend Api — Sign Ins
  description: 'Clerk Sign Ins capability. 9 operations. Lead operation: Create a New Sign in or Replace the Current One..'
  tags:
  - Clerk
  - Sign Ins
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CLERK_PUBLISHABLE_KEY: CLERK_PUBLISHABLE_KEY
capability:
  consumes:
  - type: http
    namespace: clerk-frontend-api-sign-ins
    baseUri: ''
    description: Clerk clerk-frontend-api Sign Ins business capability.
    resources:
    - name: v1-client-sign-ins
      path: /v1/client/sign_ins
      operations:
      - name: createSignIn
        method: POST
        description: Create a New Sign in or Replace the Current One.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Origin
          in: header
          type: string
          description: The origin of the request
          required: false
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-client-sign-ins-sign-in-id
      path: /v1/client/sign_ins/{sign_in_id}
      operations:
      - name: getSignIn
        method: GET
        description: Retrieve Sign-in
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_in_id
          in: path
          type: string
          description: The ID of the sign in to be retrieved.
          required: true
    - name: v1-client-sign-ins-sign-in-id-reset-password
      path: /v1/client/sign_ins/{sign_in_id}/reset_password
      operations:
      - name: resetPassword
        method: POST
        description: Reset Password on Sign-in
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_in_id
          in: path
          type: string
          description: The ID of the sign in to be retrieved.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-client-sign-ins-sign-in-id-prepare-first-factor
      path: /v1/client/sign_ins/{sign_in_id}/prepare_first_factor
      operations:
      - name: prepareSignInFactorOne
        method: POST
        description: Prepare First Factor Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_in_id
          in: path
          type: string
          description: The ID of the sign in to be retrieved.
          required: true
        - name: Origin
          in: header
          type: string
          description: The origin of the request
          required: false
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-client-sign-ins-sign-in-id-attempt-first-factor
      path: /v1/client/sign_ins/{sign_in_id}/attempt_first_factor
      operations:
      - name: attemptSignInFactorOne
        method: POST
        description: Attempt First Factor Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_in_id
          in: path
          type: string
          description: The ID of the sign in.
          required: true
        - name: Origin
          in: header
          type: string
          description: The origin of the request
          required: false
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-client-sign-ins-sign-in-id-prepare-second-factor
      path: /v1/client/sign_ins/{sign_in_id}/prepare_second_factor
      operations:
      - name: prepareSignInFactorTwo
        method: POST
        description: Prepare Second Factor Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_in_id
          in: path
          type: string
          description: The ID of the sign in.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-client-sign-ins-sign-in-id-attempt-second-factor
      path: /v1/client/sign_ins/{sign_in_id}/attempt_second_factor
      operations:
      - name: attemptSignInFactorTwo
        method: POST
        description: Attempt Second Factor Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sign_in_id
          in: path
          type: string
          description: The ID of the sign in.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-tickets-accept
      path: /v1/tickets/accept
      operations:
      - name: acceptTicket
        method: GET
        description: Accept Ticket
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ticket
          in: query
          type: string
          description: The JWT with verification information
          required: true
    - name: v1-verify
      path: /v1/verify
      operations:
      - name: verify
        method: GET
        description: Attempt Email Link Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: token
          in: query
          type: string
          description: The JWT with verification information
          required: true