setting/user_group/get
POST/setting/user_group/getThis returns the list of user groups in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The user group ID to search for specifically.
Filter the list of user groups modified after the spcified date.
Filter the list of user groups to include deleted records.
Filter the list of user groups by channel group ID, comma separated values.
Page number of the results.
The key for the ordering of the results. Accepts "name", "date_modified"
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"user_group_id": 0,
"filter_date_modified": "string",
"filter_deleted": true,
"filter_channel_group_id": "string",
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
Returns only if there is an error.
The list of user groups.
The user group ID.
The channel group ID.
The user group name.
The user group permissions.
The user group IP restrictions.
The date time user group was last modified.
Indicates if the user group has been deleted. Only returned if filter_deleted is "1".
{
"error": [
"string"
],
"user_groups": [
{
"user_group_id": 0,
"channel_group_id": 0,
"name": "string",
"permission": {},
"ip_restriction": "string",
"date_modified": "string",
"deleted": true
}
]
}