List effective group users
Returns the list of effective group users, which includes both who directly belong to the group, as well as users who belong to the group indirectly through its parent groups.
This operation requires group_view privilege.
For administrator who does not belong to this group
oz_groups_list_relationships privilege is required.
Example cURL requests
Get effective group users
curl -u username:password -X GET \
https://$HOST/api/v3/onezone/groups/$GROUP_ID/effective_users
{
"users": [
"lb0NvUXIVguzjQ3dBOXAyd1c11fWKB5dKJDQ6YvB7a0"
]
}
Path parameters
| Parameter | Type & Description |
|---|---|
| id required | string Group Id. |
Request Examples
onezone-rest-cli listEffectiveGroupUsers id=538ef9643ae6b9e40817e51eece7e341Responses
The list of effective user Ids that belong to a specific group
| Property | Type & Description |
|---|---|
users array of strings The list of user Ids. | |
Example
{
"users": [
"1d24c36707d99197c6cd995810a43aca",
"6825604b0eb6a47b8b7a04b6369eb24d"
]
}Invalid request.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
| Property | Type & Description | ||||||
|---|---|---|---|---|---|---|---|
error object Object describing an error.
| |||||||
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}