Get role information

v1.0.0

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 .
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

: Light

Input

{
  "type": "object",
  "properties": {
    "roleId": {
      "type": "string"
    }
  },
  "required": [
    "roleId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Description of the role."
    },
    "id": {
      "type": "string",
      "description": "Role Id."
    },
    "name": {
      "type": "string",
      "description": "Name of the role."
    },
    "privileges": {
      "type": "array",
      "description": "Privileges assigned to the role. Can be one or a combination of [these permissions](https://marketplace.zoom.us/docs/api-reference/other-references/privileges).\n",
      "items": {
        "type": "string"
      }
    },
    "sub_account_privileges": {
      "type": "object",
      "description": "This field will only be displayed to accounts that are enrolled in a partner plan and follow the master accounts and sub accounts structure.",
      "properties": {
        "second_level": {
          "type": "integer",
          "description": "Indicates how the account can manage sub accounts. The value can be one of the following:<br>\n`1`: Manage the sub account as an owner of the account.<br>\n`2`: Manage the sub account with the same privileges as the current account.<br>\n`3`: Manage the sub account with specified privileges."
        }
      }
    },
    "total_members": {
      "type": "integer",
      "description": "Total members assigned to that role."
    }
  }
}