CyberArk Identity Authentication API

openapi: 3.1.0
info:
  title: CyberArk Identity REST Authentication API
  version: 2026-05
  description: 'CyberArk Identity (formerly Idaptive) REST API. Provides

    authentication, OAuth/OIDC token issuance, user and organization

    management, extended user attributes/schema, and SCIM v2 user/group

    provisioning against a CyberArk Identity tenant.


    Best-effort spec derived from publicly indexed CyberArk Identity

    developer documentation (api-docs.cyberark.com, docs.cyberark.com,

    and third-party API directory listings). The authoritative reference

    is https://api-docs.cyberark.com/identity-docs-api/docs/identity-apis.


    The host should be set to your CyberArk Identity tenant URL —

    e.g. https://aab1234.id.cyberark.cloud.

    '
  contact:
    name: CyberArk Developer Hub
    url: https://api-docs.cyberark.com/identity-docs-api/docs/identity-apis
  license:
    name: Proprietary
servers:
- url: https://{tenant}.id.cyberark.cloud
  description: CyberArk Identity tenant
  variables:
    tenant:
      default: aab1234
      description: Your CyberArk Identity tenant prefix.
security:
- BearerAuth: []
tags:
- name: Authentication
paths:
  /Security/StartAuthentication:
    post:
      tags:
      - Authentication
      summary: Begin an interactive authentication session
      description: 'Starts an authentication session for a user identified by username

        and tenant. Returns the available authentication mechanisms; the

        client must complete the flow with /Security/AdvanceAuthentication

        within five minutes.

        '
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - User
              properties:
                User:
                  type: string
                  description: Username (UPN).
                Version:
                  type: string
                  example: '1.0'
      responses:
        '200':
          description: Authentication session started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthChallengeResult'
  /Security/AdvanceAuthentication:
    post:
      tags:
      - Authentication
      summary: Submit a mechanism response and advance the auth session
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - SessionId
              - MechanismId
              properties:
                SessionId:
                  type: string
                MechanismId:
                  type: string
                Answer:
                  type: string
                Action:
                  type: string
                  example: Answer
      responses:
        '200':
          description: Auth advanced (challenge or success)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthChallengeResult'
  /Security/Logout:
    post:
      tags:
      - Authentication
      summary: Log out the current session
      responses:
        '200':
          description: Logged out
components:
  schemas:
    AuthChallengeResult:
      type: object
      properties:
        success:
          type: boolean
        Result:
          type: object
          properties:
            SessionId:
              type: string
            TenantId:
              type: string
            Challenges:
              type: array
              items:
                type: object
                properties:
                  Mechanisms:
                    type: array
                    items:
                      type: object
                      properties:
                        Name:
                          type: string
                        MechanismId:
                          type: string
                        AnswerType:
                          type: string
            Summary:
              type: string
        Message:
          type: string
          nullable: true
        Exception:
          type: string
          nullable: true
        ErrorCode:
          type: string
          nullable: true
        ErrorID:
          type: string
          nullable: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 / OIDC bearer token issued by /OAuth2/Token/{appId}.
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic with OAuth client credentials, used only for /OAuth2/Token/{appId}.
externalDocs:
  description: CyberArk Identity API reference
  url: https://api-docs.cyberark.com/identity-docs-api/docs/identity-apis