Skip to main content

CyberArk Identity

CyberArk Identity connector for managing users, roles, applications, groups, organization units, policies, and directory services.

📝 Beta: This connector is in beta. It follows the service's documented API but has not yet been fully tested against the live service, so some tools may behave differently than described.

Set up​

CyberArk Identity connects with credentials from your CyberArk Identity account. Have these values ready:

  • Subdomain
  • Username
  • Password
  1. Go to Organization > Connectors and find CyberArk Identity.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

CyberArk Identity offers 34 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (20)​

View and search information without changing it.

ToolWhat it does
get_applicationGet one application's full configuration by its row key (use list_applications to find valid IDs).
get_organizationGet one organization unit's details (name, description, path) by its ID.
get_policyRetrieve a policy set's full configuration block by its path/name, e.g. '/Policy/Default Policy'.
get_roleGet a single role's details (ID, name, description) by its internal ID.
get_tenant_suffixesList the username suffixes (directory aliases) configured for the tenant.
get_userGet a single CyberArk Identity user's details by their internal UUID.
get_user_attributesGet a user's full attribute set by UUID (use list_users or get_user to find it): directory attributes, group memberships, account state, and password-policy flags, beyond the lean fields get_user returns.
get_user_rolesList the roles (and administrative rights) assigned to a user, identified by UUID (use list_users or get_user to find it).
list_administrative_rightsList distinct administrative rights held by roles of the connected, signed-in account.
list_applicationsList or search the web/SaaS applications configured on the tenant with pagination.
list_auth_profilesList the authentication (MFA) profiles configured on the tenant, each with its UUID, name, and challenge duration.
list_devicesList the devices enrolled/managed on the tenant with pagination, each with its ID, name, and enrollment state.
list_directoriesList the directory services configured on the tenant (cloud directory, Active Directory, federated directories, etc.), each with its UUID, type, display name, and status.
list_groupsList or search directory groups across the tenant's directory services with pagination.
list_organizationsList the organization units (sub-organizations) configured on the tenant, each with its ID, name, path, and administrators.
list_role_appsList the applications assigned to a role, identified by its ID (use list_roles to find it).
list_role_membersList the members (users, groups, and nested roles) of a role, identified by its ID.
list_rolesList or search CyberArk Identity roles with pagination.
list_usersList or search CyberArk Identity users with pagination.
validate_credentialValidate CyberArk Identity credentials by signing in and calling Security/whoami.

Write (5)​

Create or send data.

ToolWhat it does
add_users_to_roleAdd users, groups, and/or nested roles to a role, identified by role ID (use list_roles to find it).
assign_admin_rights_to_roleGrant administrative rights to a role, identified by role ID (use list_roles to find it). admin_rights is a list of opaque CyberArk right paths like ['ServiceRight/administrationShowTile'] (NOT friendly names) — call list_administrative_rights first to discover valid paths.
create_roleCreate a new role with a name and optional description.
create_userCreate a new user in the tenant's cloud directory.
invite_usersSend login/activation invitations to one or more users by UUID (use list_users to find them).

Delete or overwrite (9)​

Remove or replace existing data.

ToolWhat it does
delete_applicationPermanently delete an application instance by its row key (use list_applications to find it).
delete_rolePermanently delete a role by its ID (use list_roles to find it).
delete_userPermanently delete a user by their UUID (use list_users or get_user to find it).
exempt_user_from_mfaExempt a user from multi-factor authentication, identified by UUID (use list_users or get_user to find it).
remove_users_from_roleRemove users, groups, and/or nested roles from a role, identified by role ID (use list_roles to find it).
reset_user_passwordSet a new password for an existing user, identified by UUID (use list_users or get_user to find it).
unassign_admin_rights_from_roleRevoke administrative rights from a CyberArk Identity role using opaque ServiceRight/* paths, not friendly names.
update_roleRename a role or change its description, identified by role ID (use list_roles to find it).
update_userUpdate an existing user's display name, email, or mobile number.
⌘J