Post

/managers/

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 .

Body parameters

object

username

string Required

Manager's user name

password

string Required

Manager's password

first_name

string

Manager's first name

last_name

string

Manager's last name

roles

Array of integer

Joins manager to specified roles. Specify as an array of role IDs, separated by commas.

integer

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

tenant_id

integer

Tenant ID. If user_type is TENANT_ADMIN, specify the ID of the tenant to which to grant admin access.

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

201

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

Create Manager (VMS User)