Skip to main content
Get a list of all users in the vault. Required Permissions for using this action:
  • Audit users
External DocumentationTo learn more, visit the CyberArk documentation.

​
Basic Parameters

ParameterDescription
Component UserFilter users by type. Select true to include only component users, false to include only non-component users, or leave empty to return all users.
Extended DetailsSelect to include additional detailed information in the response.
SearchSearch users by username, first name, or last name.
SortThe property by which to sort the retrieved results.

​
Advanced Parameters

ParameterDescription
LimitThe maximum number of items to retrieve per request.

Note: This parameter can only be used with CyberArk - Privilege Cloud connection and cannot be used without an offset value.
OffsetThe index of the first result to retrieve.

Note: This parameter can only be used with CyberArk - Privilege Cloud connection and cannot be used without a limit value.

​
Example Output

{
	"Users": [
		{
			"id": 2,
			"username": "Administrator",
			"source": "CyberArk",
			"userType": "Built-InAdmins",
			"componentUser": false,
			"groupsMembership": [
				{
					"groupID": 16,
					"groupName": "PVWAMonitor",
					"groupType": "Vault"
				},
				{
					"groupID": 17,
					"groupName": "PVWAUsers",
					"groupType": "Vault"
				},
				{
					"groupID": 11,
					"groupName": "Vault Admins",
					"groupType": "Vault"
				}
			],
			"vaultAuthorization": [
				"AddUpdateUsers",
				"AddSafes",
				"AddNetworkAreas",
				"ManageDirectoryMapping",
				"ManageServerFileCategories",
				"AuditUsers",
				"BackupAllSafes",
				"RestoreAllSafes",
				"ResetUsersPasswords",
				"ActivateUsers"
			],
			"allowedAuthenticationMethods": [
				"SAML",
				"PKI"
			],
			"location": "\\",
			"personalDetails": {
				"firstName": "Jen",
				"middleName": "R",
				"lastName": "Grey"
			}
		}
	],
	"Total": 1
}

​
Workflow Library Example

List Users with Cyberark and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop