This web service returns a user's groups. It distinguishes between groups coming from a post-authentication script and those set manually by an administrator.
Method | Endpoint |
---|---|
GET |
|
Path parameter | Type | Description |
---|---|---|
{userId} |
String | The user's identifier. See the List users or Search users web services to find a user's ID. It is also possible to get a user's ID from the Manage users menu. |
Response body
The following lines show an example of a JSON response body:
{
"id": "a43eb18a-3f48-4732-9389-61b540ce9d0d",
"manualGroups": [
"group1"
],
"authenticationGroups": [
"group2",
"group3"
]
}
Field | Type | Description |
---|---|---|
id |
String | The user's identifier. |
manualGroups |
Array | The groups an administrator manually assigned to the user. |
authenticationGroups |
Array | The groups provided by the post-authentication script. |
Return code | Description |
---|---|
200 OK |
The request is valid and returns data. |
401 UNAUTHORIZED |
The authorization header is absent or invalid. |
403 FORBIDDEN |
The user or API key does not have the ADMIN or USERS_ADMIN role. |
404 NOT FOUND |
No user exists with this ID. |
For a comprehensive list of all possible return codes, see Return codes.