Get role information

Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges.

Use this API to get information including specific privileges assigned to a role.
Pre-requisite:

A Pro or higher plan.

For role management and updates, you must be the Account Owner or user with role management permissions.

Scopes: role:read:admin

Rate Limit Label: Light

{ "description": "string", "id": "string", "name": "string", "privileges": [ "string" ], "sub_account_privileges": { "second_level": 0 }, "total_members": 0 }

返回响应

🟢200**Status Code:** `200`<br> Information about a specific role returned. **Error Code:** `200`<br> You do not have the permission to retrieve role information.

application/json

Body

description

string

可选

Description of the role.

string

Role Id.

可选

name

string

可选

Name of the role.

privileges

array[string]

可选

Privileges assigned to the role. Can be one or a combination of these permissions.

sub_account_privileges

object

可选

This field will only be displayed to accounts that are enrolled in a partner plan and follow the master accounts and sub accounts structure.

second_level

integer

可选

Indicates how the account can manage sub accounts. The value can be one of the following:
1: Manage the sub account as an owner of the account.
2: Manage the sub account with the same privileges as the current account.
3: Manage the sub account with specified privileges.

total_members

integer

可选

Total members assigned to that role.

🔵300**Error Code:** `300`<br> Role not found.

Get role information

请求参数

返回响应