Add users

Method

URL

Required authentication

POST

/V1/CMDB/Users

Yes

Token*required
(header)

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

body*required
(body)

The body contains the following parameters:

▪username* (string): the username to log into your NetBrain domain.

▪email* (string): the email address of the user.

▪firstName* (string): the first name of the user.

▪lastName* (string): the last name of the user.

▪password* (string): the login password. The allowed length is 6-128 characters.

▪authenticationType (integer): the authentication type for the user account.

o1: Local

o2: External

▪phoneNumber (string): the phone number of the user.

▪department (string): the department that the user belongs to.

▪description (string): the description of the account.

▪allowChangePassword (bool): determine whether to allow the user to change individual password.

▪deactivatedTime (string): specify the time when the account is expired.

▪isSystemAdmin (bool): determine whether to allocate system administrator role to the user.

▪tenants (object): specify a list of tenants for the user. Only required if the value of the isSystemAdmin parameter is false.

otenantName (string): the tenant that the user can access.

oisTenantAdmin (bool): determine whether to allocate the tenant administrator role to the user. If false, you need to specify a domain for the user to access.

oallowCreateDomain (bool): determine whether to allow the user to create domains.

odomains (object): required only if the value of the isTenantAdmin parameter is false.

odomainName (string): the domain name.

odomainRoles(string): the role of the domain user. Specify a tenant for the user.

Example:

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

statusCode

integer

The returned status code of executing the API.

{
  "statusCode": 790200,
  "statusDescription": "success"
}

statusDescription

string

The explanation of the status code.