User groups users REST API
Use this REST API to manage user groups users.
Get all user groups users
| REST API information | Value | Description |
|---|---|---|
| URI | /admin/resources/user_groups_users | |
| Method | GET | |
| Returns | 200 | Returns a list of all user groups users |
| 404 | The user groups user list was not found | |
| 500 | Platform System Manager encountered an internal error while processing the request. |
Returns a list of user groups users.
You can use optional parameters to modify the response from GET calls. For more information, see Custom responses from GET calls.
- created_time
- The time at which the object is created
- id
- The unique ID of the object in the system.
- label_key
- Key for retrieving label for the user group user
- lable_text
- Default label for the user group user
- state
- The general availability of the object. If "pending" the object has been created but not activated. If "available" the object is active in the system.
- updated_time
- The time at which the object was last updated
- user_groups
- The URI of an existing user group in the system
- users
- The URI of an existing user in the system
Get a specific user groups user
| REST API information | Value | Description |
|---|---|---|
| URI | /admin/resources/user_groups_users/{id} | |
| Method | GET | |
| Returns | 200 | The user groups user was returned. |
| 404 | The user groups user was not found | |
| 500 | Platform System Manager encountered an internal error while processing the request. |
Returns a single user groups user identified by {id}.
You can use optional parameters to modify the response from GET calls. For more information, see Custom responses from GET calls.