List Users - BlinkOps Documentation

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

Parameter	Description
Component User	Filter 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 Details	Select to include additional detailed information in the response.
Search	Search users by username, first name, or last name.
Sort	The property by which to sort the retrieved results.

Advanced Parameters

Parameter	Description
Limit	The 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.
Offset	The 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
}