Management APIReferenceUsers

SetUserInfo

View as Markdown

Edits the user.

Allowed roles: Owner, Admin, User manager.

Example request: Edit the user password.

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_idintegerOptional

The user to edit. Required unless user_name is provided.

user_namestringOptional

The user name. Required unless user_id is provided.

application_idintegerOptional

The application ID. It is required if the user_name is specified

application_namestringOptional

The application name that can be used instead of application_id

new_user_namestringOptional

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

user_display_namestringOptional
The new user display name. The length must be less than 256
user_passwordstringOptional
The new user password. Must be at least 8 characters long and contain at least one uppercase and lowercase letter, one number, and one special character
parent_accountingbooleanOptional
Whether to use the parent account's money, 'false' to use a separate user 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