Users
Contents
Users
A user represents a person that has certain permissions to operate with a single customer's resources.
List users
GET /v3/settings/users
It lists the users belonging to a customer.
Inputs
None
Returns
An array of users, each with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the user. |
| first_name | String | First name of the user. |
| last_name | String | Last name of the user. |
| String | Email of the user. | |
| customer_id | String | Identifier of the customer to which the user belongs. |
| language | String | Language code identifying the locale used to show the UI to the user. |
| timezone | String | Timezone applied to show schedules and interpret monitoring queries by the user on the UI. |
| phone | String | The phone of the user. |
| roles | Array of strings | List of names of the different roles the user has assigned. |
| resource_type | String | An identifier for the type of resource, specifically "user". |
Show user
GET /v3/settings/users/:id
It shows information about a user.
Inputs
None
Returns
A user with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the user. |
| first_name | String | First name of the user. |
| last_name | String | Last name of the user. |
| String | Email of the user. | |
| customer_id | String | Identifier of the customer to which the user belongs. |
| language | String | Language code identifying the locale used to show the UI to the user. |
| timezone | String | Timezone applied to show schedules and interpret monitoring queries by the user on the UI. |
| phone | String | The phone of the user. |
| roles | Array of strings | List of names of the different roles the user has assigned. |
| resource_type | String | An identifier for the type of resource, specifically "user". |
Create user
POST /v3/settings/users
It creates a user belonging to the customer using the API.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| first_name | String | First name of the user. | Yes |
| last_name | String | Last name of the user. | Yes |
| language | String | Language code identifying the locale used to show the UI to the user. It must correspond to a locale available in the platform. | No, "en" by default. |
| timezone | String | Timezone applied to show schedules and interpret monitoring queries by the user on the UI. | No, "London" by default. |
| role_ids | Array of strings | List of identifies of the different roles the user has assigned. | Yes |
Returns
A user with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the user. |
| first_name | String | First name of the user. |
| last_name | String | Last name of the user. |
| String | Email of the user. | |
| customer_id | String | Identifier of the customer to which the user belongs. |
| language | String | Language code identifying the locale used to show the UI to the user. |
| timezone | String | Timezone applied to show schedules and interpret monitoring queries by the user on the UI. |
| phone | String | The phone of the user. |
| roles | Array of strings | List of names of the different roles the user has assigned. |
| resource_type | String | An identifier for the type of resource, specifically "user". |
Destroy user
DELETE /v3/settings/users/:id
It removes an existent user.
Inputs
None
Returns
None