Patch

/managers/{id}/

This endpoint modifies a manager user.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Path parameters

id

stringRequired

Manager ID

Body parameters

object

username

string

Manager's user name

password

string

Manager's password

first_name

string

Manager's first name

last_name

string

Manager's last name

roles

Array of integer

Specify all role IDs to update the roles assigned to the manager

integer

realm

string

Realm type

permissions

string

permission type

permissions_list

Array of string

Specify permissions list as an array of permission codenames in the format PERMISSION-REALM. To list permission codenames, run /permissions/get.

string

object_type

string

object type

object_id

integer

object ID

is_temporary_password

boolean

The password is temporary. Expiration of temporary passwords is controlled by the tmp_pwd_expiration_timeout setting, which you can modify and retrieve through the /vms//pwd_settings/ path.

password_expiration_disabled

boolean

Password expiration is disabled

user_type

string

Manager user type. SUPER_ADMIN aka 'cluster admin' = VMS manager users who can log into the cluster VMS to manage the cluster. TENANT_ADMIN=VMS manager users who can log into a specific tenant's VMS to manage that tenant.

Valid values[ "SUPER_ADMIN", "TENANT_ADMIN" ]

Responses

200

OK

Expand All

object

id

integer

username

string

Username for VMS login

full_name

string

First and last name

password

string

Password for VMS login

password_retype

string

Retype the password

first_name

string

Manager's first name

last_name

string

Manager's first name

roles

object

Roles assigned to the manager

permissions

object

object_permissions

object

is_default

boolean

Sets the manager to be the default manager

is_active

boolean

True if manager is active

failed_logins

integer

Number of failed logins

is_temporary_password

boolean

Sets the password to be temporary. Expiration of temporary passwords is controlled by the tmp_pwd_expiration_timeout setting, which you can modify and retrieve through the /vms//pwd_settings/ path.

password_expiration_disabled

boolean

Password expiration is disabled

password_expiration

string (date-time)

Password expiration

last_login

string (date-time)

Last login time

tenant_id

integer

Tenant ID

guid

string

user_type

string

Manager user type. SUPER_ADMIN aka 'cluster admin' = VMS manager users who can log into the cluster VMS to manage the cluster. TENANT_ADMIN=VMS manager users who can log into a specific tenant's VMS to manage that tenant.

Valid values[ "SUPER_ADMIN", "TENANT_ADMIN" ]

tenant

object (PartialTenantInfo)

id

integer

Tenant ID

name

string

Tenant Name

Modify Manager (VMS User)