Get user

This endpoint retrieves the details of the requested user.

Method	Path	Operation*
GET	/users/{user}	get_user

*

In order for a user to perform the "get_user" operation, the "get_user" permission must be included in the list of allowed actions in the statement of the user's role. footnote

Request

Parameter	Type	In	Description
{user} required	string	path	User UUID.

In our example, we retrieve the user with the user UUID "3d0f1348-612a-4804-b632-24c4b871e76e":

Response

Attribute	Type	Description
uuid	string	User UUID.
name	string	Name of the user. It must match the regular expression(opens new window) ^[0-9A-Za-z][0-9A-Za-z_ \-]{0,30}[0-9A-Za-z]$. It does not need to be unique in the context of the account.
account	string	Account UUID.
role	string	Role UUID.
description	dictionary	Attributes of the user in form of key-value pairs: - key: It must match the regular expression(opens new window) ^[a-z_][0-9a-z_]{0,63}$. - value: JSON compliant value. For more details consult the description field section.
created_ts	timestamp	Time at which the user was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window).
updated_ts	timestamp	Time at which the user was last updated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch(opens new window).
activity optional **	dictionary	User Activity Log attribute. It holds the name(s) of the Timeseries table(s) where the User Activity Log is to be stored, and (optionally) the "dimensions" attribute. Attribute Type In Description dimensions dictionary body Key-value pairs: - key: name of the dimension under which the User Activity Log entry is to be stored. - value: Template for the value of the dimension.

Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.