/user/read | Documentation

This API allows to list user information.

The user must be authenticated. Customer admin can list all users for the customer.

Request

A request with no fields will return the user's own information. For customer admin (?customerAdmin=true) all users for the customer will be listed.

Response

The response object has the following fields:

Name	Type	Description
`users`	Array of Object	Array of user objects.

A regular user object has the following fields:

Name	Type	Description
`username`	String	User name.
`enabledFeatures`	Array of Object	Array of feature objects.
`apiKey`	String	The api key. This field is only shown if feature `apiKeyOwner` is enabled and it is hidden for customer admin.
`createdTime`	String	The creation time. Only available for customer admin (`?customerAdmin=true`)
`createdBy`	String	User name of person who created user. Only available for customer admin (`?customerAdmin=true`)
`lastChangedAt`	String	The last changing time. Only available for customer admin (`?customerAdmin=true`)
`lastUpdatedBy`	String	User name of last person who modified user. Only available for customer admin (`?customerAdmin=true`)
`lastLogin`	String	The last login time. Only available for customer admin (`?customerAdmin=true`)
`lastAccess`	String	The last time the user accessed an API. Only available for customer admin (`?customerAdmin=true`)
`roleId`	Integer	The current user role id
`roleName`	String	The current user role name

See /user/update for details about the feature object.

Examples

Bash

$ cx.py /user/read
{
 "users": [
 {
 "username": "some.user@example.com",
 "enabledFeatures": [
 {
 "feature": "apiKeyOwner",
 "enabled": true
 }
 ],
 "apiKey": "api&user&tm/aBcDeFg123=="
 }
 ]
}

Bash

$ cx.py /user/read?customerAdmin=true
{
 "users": [
 {
 "username": "some.user@example.com",
 "enabledFeatures": [
 {
 "feature": "apiKeyOwner",
 "enabled": true
 }
 ],
 "createdTime": "2014-05-17T06:00:00.000Z",
 "createdBy": "foo@bar.com",
 "lastChangedAt": "2014-05-17T06:00:00.000Z",
 "lastUpdatedBy": "foo@bar.com"
 },
 {
 "username": "some.admin@example.com",
 "enabledFeatures": [
 {
 "feature": "customerAdmin",
 "enabled": true
 }
 ],
 "createdTime": "2019-11-25T16:21:58.029Z",
 "createdBy": "foo@bar.com",
 "lastChangedAt": "2019-11-26T16:22:58.029Z",
 "lastUpdatedBy": "example@bar.com"
 }
 ]
}

Last updated: December 28, 2023