setting/user_group/get - Equotix One API

This returns the list of user groups in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

user_group_id

integer

optional

The user group ID to search for specifically.

filter_date_modified

string

optional

Filter the list of user groups modified after the spcified date.

filter_deleted

boolean

optional

Filter the list of user groups to include deleted records.

filter_channel_group_id

string

optional

Filter the list of user groups by channel group ID, comma separated values.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
  "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

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

user_groups

array [object {7}]

optional

The list of user groups.

user_group_id

integer

required

The user group ID.

channel_group_id

integer

required

The channel group ID.

name

string

required

The user group name.

permission

object

required

The user group permissions.

ip_restriction

string

required

The user group IP restrictions.

date_modified

string

required

The date time user group was last modified.

deleted

boolean

optional

Indicates if the user group has been deleted. Only returned if filter_deleted is "1".

Example

{
  "error": [
    "string"
  ],
  "user_groups": [
    {
      "user_group_id": 0,
      "channel_group_id": 0,
      "name": "string",
      "permission": {},
      "ip_restriction": "string",
      "date_modified": "string",
      "deleted": true
    }
  ]
}