Get

/roles/{id}/

This endpoint returns details of a manager role.

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

Role ID

Responses

200

Expand All

object

id

integer

name

string

The name of the role.

managers

Array of object

Managers to which the role is granted

object

permissions

Array of string

A list of permission codenames (<permission_type>_). Note, that this does not correspond to provided in POST/PATCH schema's permissions, which is a legacy name.

string

Examplecreate_applications

is_default

boolean

True if default role. Default role cannot be deleted.

is_admin

boolean

Is the role is an admin role

ldap_groups

Array of string

LDAP group(s) associated with the role. Members of the specified groups on a connected LDAP/Active Directory provider can access VMS and are granted whichever permissions are included in the role. A group can be associated with multiple roles.

string

tenants

Array of integer

Tenants for the role

integer

tenant_names

string

Tenant names for the role

tenant_id

integer

Tenant ID

guid

string

tenant

object (PartialTenantInfo)

id

integer

Tenant ID

name

string

Tenant Name

Return Details of a Role