Get Role | VMware Horizon Server API

Get Role

All the listed privileges are required -

Privileges	Description
GLOBAL_ROLE_VIEW	Caller should have permission to this privilege, to perform this operation.
GLOBAL_PERMISSION_VIEW	Caller should have permission to this privilege, to read the permission IDs for Role.

Request

URI

GET

https://{api_host}/rest/config/v1/roles/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns RoleInfo of type(s) */*

{
    "applies_to_federation_access_group": true,
    "applies_to_local_access_group": true,
    "built_in_role_type": "INVENTORY_ADMIN",
    "description": "Administration users with rights for global and per Connection Server configuration settings.",
    "id": "42e47f15-aad0-221a-b231-ea4a3a134ec9",
    "name": "Global Configuration and Policy Administrators",
    "permission_ids": [
        "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
        "6fd4638a-381f-4518-aed6-042aa3d9f14c"
    ],
    "privileges": [
        "GLOBAL_ADMIN_UI_INTERACTIVE",
        "GLOBAL_CONFIG_MANAGEMENT",
        "GLOBAL_CONFIG_VIEW",
        "GLOBAL_CVP_PUBLICATION"
    ]
}

boolean

applies_to_federation_access_group

Optional

Specifies whether federated access group is applicable for this role. This will be true when the role contains atleast one of FEDEREATED_LDAP_MANAGE, FEDEREATED_LDAP_VIEW, FEDERATED_SESSIONS_MANAGE or FEDERATED_SESSIONS_VIEW privilege.

boolean

applies_to_local_access_group

Optional

Specifies whether local access group is applicable for this role. This will be true when the role contains atleast one inventory specific privilege.

string

built_in_role_type

Optional

The role type. It will be null for custom roles.

ADMINISTRATOR: Role with full administrative rights.
ADMINISTRATOR_READ_ONLY: Role with full read-only administrative rights.
AGENT_REGISTRATION_ADMIN: Role with rights to register Agents.
GLOBAL_CONFIG_AND_POLICY_ADMIN: Role with rights for View Configuration settings and policies.
GLOBAL_CONFIG_AND_POLICY_ADMIN_READ_ONLY: Role with read-only rights for View Configuration settings and policies.
HELP_DESK_ADMIN: Role with rights for Help Desk portal management.
HELP_DESK_ADMIN_READ_ONLY: Role with read only rights for Help Desk portal management.
INVENTORY_ADMIN: Role with rights for inventory management.
INVENTORY_ADMIN_READ_ONLY: Role with read only rights for inventory management.
LOCAL_ADMIN: Local Pod Administration role with full administrative rights.
LOCAL_ADMIN_READ_ONLY: Local Pod Administration role with full read-only administrative rights.
UNKNOWN_ROLE: Unknown Role type.

Possible values are : ADMINISTRATOR, ADMINISTRATOR_READ_ONLY, AGENT_REGISTRATION_ADMIN, GLOBAL_CONFIG_AND_POLICY_ADMIN, GLOBAL_CONFIG_AND_POLICY_ADMIN_READ_ONLY, HELP_DESK_ADMIN, HELP_DESK_ADMIN_READ_ONLY, INVENTORY_ADMIN, INVENTORY_ADMIN_READ_ONLY, LOCAL_ADMIN, LOCAL_ADMIN_READ_ONLY, UNKNOWN_ROLE,

string

description

Optional

Role description.

string

Optional

Unique ID representing this role.

string

name

Optional

Role name.

array of string

permission_ids

Optional

Administrative permissions (user/group and access group) for this role.

array of string

privileges

Optional

Privileges for this role.

Possible values are : ADMINISTRATOR, ADMINISTRATOR_VIEW, VC_CONFIG_VIEW, LOG_COLLECTION, FORENSICS, MANAGE_CERTIFICATES, LOCAL_ADMINISTRATOR, LOCAL_ADMINISTRATOR_VIEW, INVENTORY_ADMINISTRATOR, INVENTORY_ADMINISTRATOR_VIEW, HELPDESK_ADMINISTRATOR, HELPDESK_ADMINISTRATOR_VIEW, FEDERATED_LDAP_MANAGE, FEDERATED_LDAP_VIEW, FEDERATED_SESSIONS_MANAGE, FEDERATED_SESSIONS_VIEW, GLOBAL_ADMINISTRATOR, GLOBAL_ADMINISTRATOR_VIEW, GLOBAL_ADMIN_UI_INTERACTIVE, GLOBAL_ADMIN_SDK_INTERACTIVE, GLOBAL_MACHINE_REGISTER, GLOBAL_ROLE_PERMISSION_MANAGEMENT, GLOBAL_ROLE_MANAGEMENT, GLOBAL_ROLE_VIEW, GLOBAL_PERMISSION_VIEW, GLOBAL_PERMISSION_MANAGEMENT, GLOBAL_CONFIG_VIEW, GLOBAL_CONFIG_MANAGEMENT, FOLDER_MANAGEMENT, FOLDER_VIEW, POOL_VIEW, POOL_MANAGEMENT, POOL_ENABLE, POOL_ENTITLE, POOL_SVI_IMAGE_MANAGEMENT, MACHINE_VIEW, MACHINE_MANAGEMENT, MACHINE_REBOOT, MACHINE_MANAGE_VDI_SESSION, MACHINE_MANAGE_OFFLINE_SESSION, MACHINE_USER_MANAGEMENT, MACHINE_MAINTENANCE, MANAGE_REMOTE_PROCESS, REMOTE_ASSISTANCE, GLOBAL_CVP_REGISTER, GLOBAL_CVP_PUBLICATION, CVP_INTERACTIVE, CVP_VIEW, CVP_MANAGEMENT, CVP_OWNERSHIP, API_SMART_CARD_BYPASS, UDD_VIEW, UDD_MANAGEMENT, HORIZON_CLOUD_SERVICE, SUBSCRIPTION_LICENSE_ADD, CLOUD_ADMIN, UNKNOWN_PRIVILEGE,

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page

Description

Request