Skip to navigation

SetAdminUserInfo

View as Markdown

Edits the specified admin user.

Example request: Edit the admin 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 for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

required_admin_user_idintegerOptional

The admin user to edit. Required unless required_admin_user_name is provided.

required_admin_user_namestringOptional

The admin user to edit. Required unless required_admin_user_id is provided.

new_admin_user_namestringOptional
The new admin user name. The length must be less than 50
admin_user_display_namestringOptional
The new admin user display name. The length must be less than 256
new_admin_user_passwordstringOptional
The new admin user password. The length must be at least 6 symbols
admin_user_activebooleanOptional
Whether the admin user is active

Response

Successful response
resultintegerOptional
Returns 1 if the request has been completed successfully