REST Resource: roles

Resource: Role

JSON representation
{
  "roleId": string,
  "roleName": string,
  "roleDescription": string,
  "rolePrivileges": [
    {
      "serviceId": string,
      "privilegeName": string
    }
  ],
  "isSystemRole": boolean,
  "isSuperAdminRole": boolean,
  "kind": string,
  "etag": string
}
Fields
roleId

string (int64 format)

ID of the role.

roleName

string

Name of the role.

roleDescription

string

A short description of the role.

rolePrivileges[]

object

The set of privileges that are granted to this role.

rolePrivileges[].serviceId

string

The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().

rolePrivileges[].privilegeName

string

The name of the privilege.

isSystemRole

boolean

Returns true if this is a pre-defined system role.

isSuperAdminRole

boolean

Returns true if the role is a super admin role.

kind

string

The type of the API resource. This is always admin#directory#role.

etag

string

ETag of the resource.

Methods

delete

Deletes a role.

get

Retrieves a role.

insert

Creates a role.

list

Retrieves a paginated list of all the roles in a domain.

patch

Patch role via Apiary Patch Orchestration

update

Updates a role.