Resource: Role
A role in the Identity and Access Management API.
JSON representation |
---|
{
"name": string,
"title": string,
"description": string,
"includedPermissions": [
string
],
"stage": enum ( |
Fields | |
---|---|
name |
The name of the role. When Role is used in roles.create, the role name must not be set. When Role is used in output and other input such as roles.patch, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles. |
title |
Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. |
description |
Optional. A human-readable description for the role. |
includedPermissions[] |
The names of the permissions this role grants when bound in an IAM policy. |
stage |
The current launch stage of the role. If the |
etag |
Used to perform a consistent read-modify-write. A base64-encoded string. |
deleted |
The current deleted state of the role. This field is read only. It will be ignored in calls to roles.create and roles.patch. |
Methods |
|
---|---|
|
Creates a new custom Role . |
|
Deletes a custom Role . |
|
Gets the definition of a Role . |
|
Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. |
|
Updates the definition of a custom Role . |
|
Undeletes a custom Role . |