AddUser

View as Markdown

Adds a new user.

Allowed roles: Owner, Admin, User manager.

Example request: Add a new user.

Authentication

AuthorizationBearer
Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

Query parameters

user_namestringRequired

The user name in format [a-z0-9][a-z0-9_-]49

user_display_namestringRequired
The user display name. The length must be less than 256
user_passwordstringRequired
The user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character
application_idintegerOptional

The application ID which a new user is to be bound to. Required unless application_name is provided.

application_namestringOptional

The application name which a new user is to be bound to. Required unless application_id is provided.

parent_accountingbooleanOptional
Whether the user uses the parent account's money, 'false' if the user has a separate balance
user_activebooleanOptionalDefaults to true
Whether the user is active. Inactive users cannot log in to applications
user_custom_datastringOptional
Any string

Response

Successful response
resultinteger
Returns 1 if the request has been completed successfully
user_idinteger
The new user ID