Role(mapping=None, *, ignore_unknown_fields=False, **kwargs)A role in the Identity and Access Management API.
Attributes | |
|---|---|
| Name | Description |
name |
str
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 predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles. |
title |
str
Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. |
description |
str
Optional. A human-readable description for the role. |
included_permissions |
MutableSequence[str]
The names of the permissions this role grants when bound in an IAM policy. |
stage |
google.cloud.iam_admin_v1.types.Role.RoleLaunchStage
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.
|
etag |
bytes
Used to perform a consistent read-modify-write. |
deleted |
bool
The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole. |
Classes
RoleLaunchStage
RoleLaunchStage(value)A stage representing a role's lifecycle phase.
Values:
ALPHA (0):
The user has indicated this role is currently in an Alpha
phase. If this launch stage is selected, the stage field
will not be included when requesting the definition for a
given role.
BETA (1):
The user has indicated this role is currently
in a Beta phase.
GA (2):
The user has indicated this role is generally
available.
DEPRECATED (4):
The user has indicated this role is being
deprecated.
DISABLED (5):
This role is disabled and will not contribute
permissions to any principals it is granted to
in policies.
EAP (6):
The user has indicated this role is currently
in an EAP phase.