For a list of methods for this resource, see the end of this page.

Resource representations

JSON template for role resource in Directory API.

  "kind": "admin#directory#role",
  "etag": etag,
  "roleId": long,
  "roleName": string,
  "roleDescription": string,
  "rolePrivileges": [
      "privilegeName": string,
      "serviceId": string
  "isSystemRole": boolean,
  "isSuperAdminRole": boolean
Property name Value Description Notes
etag etag ETag of the resource.
isSuperAdminRole boolean Returns true if the role is a super admin role.
isSystemRole boolean Returns true if this is a pre-defined system role.
kind string The type of the API resource. This is always admin#directory#role.
roleDescription string A short description of the role. writable
roleId long ID of the role.
roleName string Name of the role. writable
rolePrivileges[] list The set of privileges that are granted to this role. writable
rolePrivileges[].privilegeName string The name of the privilege.
rolePrivileges[].serviceId string The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().


Deletes a role.
Retrieves a role.
Creates a role.
Retrieves a paginated list of all the roles in a domain.
Updates a role. This method supports patch semantics.
Updates a role.