Connectors
...
Actions
Get Users
4 min
description retrieves a list of all users in the cyberark vault, excluding master and batch built in users endpoint url /passwordvault/api/users/ method get inputs parameters (object) filter (string) filters according to the rest standard search for users using the following filters usertype, componentuser and username sort (string) property or properties by which to sort returned users, followed by asc (default) or desc to control sort direction search (string) search using the following values username, firstname and lastname extendeddetails (boolean) returns additional user details as user groups and userdn for ldap users pageoffset (number) offsets the first user that is returned in the results pagesize (number) when used together with the offset parameter, this value determines the maximum number of users to return output example \[ { "status code" 200, "response headers" {}, "reason" "success", "json body" { "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" ], "location" "\\\\", "personaldetails" { "firstname" "jen", "middlename" "r", "lastname" "grey" } } ], "total" 1 } } ] output parameters status code (number) reason (string) json body (object) users (array) id (number) username (string) source (string) usertype (string) componentuser (boolean) groupsmembership (array) groupid (number) groupname (string) grouptype (string) vaultauthorization (array) location (string) personaldetails (object) firstname (string) middlename (string) lastname (string) total (number)