CyberArk Identity UserMgmt API

openapi: 3.1.0
info:
  title: CyberArk Identity REST Authentication UserMgmt 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: UserMgmt
paths:
  /UserMgmt/GetUserInfo:
    post:
      tags:
      - UserMgmt
      summary: Retrieve detailed information for a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ID:
                  type: string
      responses:
        '200':
          description: User info
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMgmtResult'
  /UserMgmt/ChangeUserAttributes:
    post:
      tags:
      - UserMgmt
      summary: Update user attribute values
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Attributes updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMgmtResult'
  /UserMgmt/InviteUsers:
    post:
      tags:
      - UserMgmt
      summary: Send system invitations to one or more users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Entities:
                  type: array
                  items:
                    type: object
                    properties:
                      ID:
                        type: string
                      Type:
                        type: string
                        example: User
      responses:
        '200':
          description: Invitations sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMgmtResult'
  /UserMgmt/SetCloudLock:
    post:
      tags:
      - UserMgmt
      summary: Lock or unlock a cloud user account
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ID:
                  type: string
                Lock:
                  type: boolean
      responses:
        '200':
          description: Lock state updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMgmtResult'
  /UserMgmt/RemoveUsers:
    post:
      tags:
      - UserMgmt
      summary: Delete cloud users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Users:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Users removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMgmtResult'
components:
  schemas:
    UserMgmtResult:
      type: object
      properties:
        success:
          type: boolean
        Result:
          type: object
          additionalProperties: true
        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