Get

Gets a Role definition

1 variables
7 variables

Gets a Role definition

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services

Input

This building block consumes 1 input parameters

  = Parameter name
  = Format

name STRING Required

The resource name of the role in one of the following formats: roles/{ROLE_NAME} organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME} projects/{PROJECT_ID}/roles/{ROLE_NAME}

Output

This building block provides 7 output parameters

  = Parameter name
  = Format

title STRING

Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes

includedPermissions[] STRING

description STRING

Optional. A human-readable description for the role

etag BINARY

Used to perform a consistent read-modify-write

stage ENUMERATION

The current launch stage of the role. If the ALPHA launch stage has been selected for a role, the stage field will not be included in the returned definition for the role

name STRING

The name of the role.

When Role is used in CreateRole, the role name must not be set.

When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for curated roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles

deleted BOOLEAN

The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole