Cyberark API Directory

CyberArk software is a leading cybersecurity solution specializing in identity security and privileged access management (PAM). It plays a crucial role in protecting organizations from cyber threats by securing privileged accounts, credentials, and secrets. As cyber threats continue to evolve, CyberArk's robust security measures ensure that sensitive data and critical infrastructure remain safeguarded. Its comprehensive approach to identity security makes it an essential tool for businesses across various industries, aiming to protect their most valuable assets.

One of the key features of CyberArk is its ability to integrate seamlessly with existing IT environments through its API. The CyberArk API facilitates smooth integration, enabling organizations to enhance their security posture without disrupting their current operations. By leveraging the CyberArk API, businesses can automate security processes, streamline identity management, and ensure compliance with industry regulations. This integration capability not only strengthens security but also optimizes operational efficiency, making CyberArk a preferred choice for enterprises seeking advanced cybersecurity solutions.

Key highlights of Cyberark APIs

The CyberArk API suite provides powerful tools to integrate and automate privileged access management (PAM) functionalities. Below are the key highlights of the CyberArk APIs:

Core Functionalities:

• Account Management: Create, retrieve, update, and delete privileged accounts to ensure efficient and secure management of credentials.
• User Management: Manage users, roles, and permissions to enforce strict access control policies.
• Session Management: Initiate, monitor, and terminate privileged sessions with support for session recording for auditing purposes.
• Policy Management: Define, update, and apply security policies for password rotation, access controls, and compliance requirements.

Integration Use Cases:

• Automated Credential Rotation: Enable seamless credential updates for critical systems as per security policies.
• Incident Response Automation: Integrate with SIEM tools to automate detection and response to security events.
• Compliance Audits: Extract detailed logs and session recordings to meet regulatory requirements.

Supported Protocols:

• RESTful API: CyberArk APIs are REST-compliant, using standard HTTP methods for resource interaction.

Authentication Mechanisms:

• Session Token Authentication: Secure API access by using session tokens obtained via the login endpoint.
• OAuth 2.0: Where supported, OAuth 2.0 can be used for enhanced security in integrations.

Rate Limiting Policies:

• Call Limits: Best practices include limiting excessive API calls and handling 429 (Too Many Requests) responses effectively.

For comprehensive information, refer to the official CyberArk API documentation.

‍

Cyberark API Endpoints

CDirectoryService

• post https://{tenant_url}/CDirectoryService/ChangeUser : Update Base Profile Identity API
• post https://{tenant_url}/CDirectoryService/ChangeUserState : Change User State - Identity API
• post https://{tenant_url}/CDirectoryService/ExemptUserFromMfa : Exempt a user from MFA - Identity API Reference
• post https://{tenant_url}/CDirectoryService/GetTechSupportUser : Fetch Technical Support User Identity API
• post https://{tenant_url}/CDirectoryService/GetUser : Get User Details - Identity API
• post https://{tenant_url}/CDirectoryService/GetUserAttributes : Get User Attributes - Identity API
• post https://{tenant_url}/CDirectoryService/GetUserByName : Get User Details by Name - Identity API
• post https://{tenant_url}/CDirectoryService/GetUsers : Get Users Details - Identity API
• post https://{tenant_url}/CDirectoryService/GetUsersFromCsvFile : Start Bulk User Import in CyberArk Identity Cloud Directory
• post https://{tenant_url}/CDirectoryService/SetUserPicture : Set User's Picture via Identity API
• post https://{tenant_url}/CDirectoryService/SetUserState : Set User State in CyberArk Identity
• post https://{tenant_url}/CDirectoryService/SubmitUploadedFile : Advance Bulk User Import - Identity API

Core

• post https://{tenant_url}/Core/GetUserSettings : Get User Settings - Identity API Reference

ExtData

• post https://{tenant_url}/ExtData/GetColumns : Get Additional Attributes for CyberArk Identity User
• post https://{tenant_url}/ExtData/GetSchema : Get Schema - Identity API Reference
• post https://{tenant_url}/ExtData/SetColumns : Set Additional Attributes for CyberArk Identity User
• post https://{tenant_url}/ExtData/UpdateSchema : Add Additional Attributes to Tenant Schema

Org

• post https://{tenant_url}/Org/ChangeMemberShip : Update Organization Membership
• post https://{tenant_url}/Org/Create : Create Organization Identity API
• post https://{tenant_url}/Org/Delete : Delete Organization - Identity API
• post https://{tenant_url}/Org/Get : Get Organization Details - Identity API
• post https://{tenant_url}/Org/GetAdministrators : Get Administrators - Identity API Reference
• post https://{tenant_url}/Org/GetPermission : Get Administrative Rights - Identity API
• post https://{tenant_url}/Org/GetRoles : Get Organization Roles - Identity API
• post https://{tenant_url}/Org/ListAll : Get All Organizations - Identity API
• post https://{tenant_url}/Org/Update : Update Organization Identity API
• post https://{tenant_url}/Org/UpdateAdministrators : Update Administrators for Organization
• post https://{tenant_url}/Org/UpdatePermission : Update Administrative Rights - Identity API

User

• post https://{tenant_url}/User/UpdateProfile : Update User Profile - Identity API

UserMgmt

• post https://{tenant_url}/UserMgmt/ChangeUserAttributes : Update AD User Attributes
• post https://{tenant_url}/UserMgmt/GetUserAttributes : Fetch attributes for a specified user
• post https://{tenant_url}/UserMgmt/GetUserHierarchy : Get User Hierarchy - Identity API
• post https://{tenant_url}/UserMgmt/GetUserInfo : Get User Information - Identity API
• post https://{tenant_url}/UserMgmt/GetUserRiskLevel : Get Risk Level for a Specified User
• post https://{tenant_url}/UserMgmt/GetUsersRolesAndAdministrativeRights : Get User Roles and Administrative Rights
• post https://{tenant_url}/UserMgmt/InviteUsers : Invite Cloud Users - Identity API
• post https://{tenant_url}/UserMgmt/IsUserCloudLocked : Check if User is Locked - Identity API
• post https://{tenant_url}/UserMgmt/IsUserLockedOutByPolicy : Check if user is locked out by policy
• post https://{tenant_url}/UserMgmt/RemoveUsers : Delete Users - Identity API
• post https://{tenant_url}/UserMgmt/SendLoginEmails : Send Invitation Email - Identity API
• post https://{tenant_url}/UserMgmt/SendSmsInvite : Send Invitation SMS - Identity API
• post https://{tenant_url}/UserMgmt/SetCloudLock : Disable or Enable a User Account

SCIM

• get https://{tenant_url}/scim/Groups : Query Groups Identity API
• delete https://{tenant_url}/scim/Groups/{id} : Delete Group Identity API
• post https://{tenant_url}/scim/Users : Create User - Identity API
• put https://{tenant_url}/scim/Users/{id} : Update User Identity API

‍

CyberArk API FAQs

How do I authenticate with the CyberArk REST API?

• Answer: To authenticate with the CyberArk REST API, you need to obtain a session token. This involves sending a POST request to the /PasswordVault/API/Auth/CyberArk/Logon endpoint with your credentials. The response will include a session token, which must be included in the Authorization header of subsequent API requests.
• Source: Authentication - CyberArk Docs

What are the rate limits for the CyberArk REST API?

• Answer: CyberArk's REST APIs are designed to be stable and predictable. While specific rate limits are not explicitly documented, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
• Source: REST APIs - CyberArk Docs

Can I retrieve account information using the CyberArk REST API?

• Answer: Yes, you can retrieve account information using the CyberArk REST API. For example, to list all accounts, you can make a GET request to the /PasswordVault/API/Accounts endpoint.
• Source: Accounts - CyberArk Docs

Does the CyberArk REST API support webhooks for real-time data updates?

• Answer: As of the latest available information, CyberArk's REST API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: REST APIs - CyberArk Docs

Are there official SDKs or client libraries for the CyberArk REST API?

• Answer: CyberArk provides a RESTful API that can be invoked by any RESTful client for various programming and scripting environments, including Java, C#, Perl, PHP, Python, and Ruby.
• Source: REST APIs - CyberArk Docs

Get Started with CyberArk API Integration

Knit API offers a convenient solution for quick and seamless integration with CyberArk API. Our AI-powered integration platform allows you to build any CyberArk API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRM, Accounting, HRIS, ATS, and other systems in one go with a unified approach. Knit handles all the authentication, authorization, and ongoing integration maintenance. This approach saves time and ensures a smooth and reliable connection to CyberArk API.‍

To sign up for free, click here. To check the pricing, see our pricing page