Get user information

Method

URL

Required authentication

Get

/V1/CMDB/Users

Yes

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

username
(query)

The name of the user that you get the information. If not specified, the API returns the information of all users.

userData

List

The returned user information. It contains the following parameters:

▪username: the user name.

▪email: the email address of the user.

▪firstName: the first name of the user.

▪lastName: the last name of the user.

▪password: the login password.

▪authenticationType: the authentication type of the user account.

o1: Local

o2: External

▪phoneNumber: the phone number of the user.

▪department: the department that the user belongs to.

▪description: the description of the user account.

▪allowChangePassword: whether the user can change the password.

▪deactivatedTime: the time when the account is expired.

▪isSystemAdmin: whether the user is an administrator.

▪tenantsAndRoles: tenants that the user can access and the user roles.

otenantId: the tenant that the user can access.

oisAdmin: decide whether to allocate the tenant administrator role to the user.

ocanAddDomain: decide whether to allow the user to create domains.

{
  "username": NetBrain,
  "email": [email protected],
  "firstName": NetBrain,
  "lastName": NetBrain,
  "password": ******,
  "authenticationType": null,
  "phoneNumber": null,
  "department": null,
  "description": null,
  "allowChangePassword": True,
  "deactivatedTime": null,
  "isSystemAdmin": True,
  "tenantsAndRoles": null
}

statusCode

integer

The returned status code of executing the API.

statusDescription

string

The explanation of the status code.