Connectors
...
Actions
Get User Groups
4 min
description retrieve a comprehensive list of user groups available within cyberark for access management and control endpoint url /passwordvault/api/usergroups/ method get inputs parameters (object) filter (string) filters according to the rest standard sort (string) property or properties by which to sort returned users, followed by asc (default) or desc to control sort direction search (string) searches according to the rest standard (searching with "contains") search matches when all search terms appear in the group name includemembers (boolean) whether or not to return members for each user group as part of the response output example \[ { "status code" 200, "response headers" {}, "reason" "success", "json body" { "value" \[ { "id" 8, "grouptype" "vault", "members" \[ { "username" "auditor", "id" 3 } ], "groupname" "auditors", "description" "auditors group", "location" "\\\\" } ], "count" 1 } } ] output parameters status code (number) reason (string) json body (object) value (array) id (number) grouptype (string) members (array) username (string) id (number) groupname (string) description (string) location (string) count (number)