Users

Contents

Users

A user represents a person that has certain permissions to operate with a single customer's resources.

List users

GET /v3/admin/customers/:customer_id/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.
email 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".

Back to top

Show user

GET /v3/admin/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.
email 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".

Back to top

Create user

POST /v3/admin/customers/:customer_id/users

It creates a user belonging to a customer

Inputs

Field Type Description Required
first_name String First name of the user. Yes
last_name String Last name of the user. Yes
email String Email 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.
phone String The phone of the user. No
roles Array of strings List of names of the different roles the user has assigned. No
role_ids Array of strings List of identifies of the different roles the user has assigned. Include this option excludes the use of input ‘roles'. No

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.
email 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".

Back to top

Update user

PUT /v3/admin/users/:id

It shows information about a user.

Inputs

Field Type Description Required
first_name String First name of the user. No
last_name String Last name of the user. No
email String Email of the user. No
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
timezone String Timezone applied to show schedules and interpret monitoring queries by the user on the UI. No
phone String The phone of the user. No
roles Array of strings List of names of the different roles the user has assigned. No
role_ids Array of strings List of identifies of the different roles the user has assigned. Include this option excludes the use of input ‘roles'. No

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.
email 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".

Back to top

Destroy user

DELETE /v3/admin/users/:id

It removes an existent user.

Inputs

None

Returns

None

Back to top