setting/user/get - Equotix One API

This returns the list of users 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_id

integer

optional

The user ID to search for specifically.

filter_user_group_id

integer

optional

Filter the list of users by the user group ID.

filter_username

string

optional

Filter the list of users by the username.

filter_date_modified

string

optional

Filter the list of users modified after the spcified date.

filter_deleted

boolean

optional

Filter the list of users to include deleted records.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "username", "name", "user_group", "date_added", "date_modified", "date_active".

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_id": 0,
  "filter_user_group_id": 0,
  "filter_username": "string",
  "filter_date_modified": "string",
  "filter_deleted": true,
  "page": 0,
  "sort": "string",
  "order": "string",
  "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

users

array [object {11}]

optional

The list of users.

user_id

integer

required

The user ID.

user_group_id

integer

required

The user group ID.

username

string

required

The username.

firstname

string

required

The user first name.

lastname

string

required

The user lastname.

string

required

The user email address.

preference

object

required

The user preference.

date_added

string

required

The date time user was created.

date_modified

string

required

The date time user was last modified.

date_active

string

required

The date time user was last active.

deleted

boolean

optional

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

Example

{
  "error": [
    "string"
  ],
  "users": [
    {
      "user_id": 0,
      "user_group_id": 0,
      "username": "string",
      "firstname": "string",
      "lastname": "string",
      "email": "string",
      "preference": {},
      "date_added": "string",
      "date_modified": "string",
      "date_active": "string",
      "deleted": true
    }
  ]
}