docs: update generated docs (#981)
diff --git a/docs/dyn/iam_v1.projects.roles.html b/docs/dyn/iam_v1.projects.roles.html
index 4d28a25..a9c4920 100644
--- a/docs/dyn/iam_v1.projects.roles.html
+++ b/docs/dyn/iam_v1.projects.roles.html
@@ -76,29 +76,29 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Creates a new Role.</p>
+<p class="firstline">Creates a new custom Role.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Soft deletes a role. The role is suspended and cannot be used to create new</p>
+<p class="firstline">Deletes a custom Role.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
-<p class="firstline">Gets a Role definition.</p>
+<p class="firstline">Gets the definition of a Role.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, showDeleted=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists the Roles defined on a resource.</p>
+ <code><a href="#list">list(parent, pageSize=None, view=None, showDeleted=None, pageToken=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists every predefined Role that IAM supports, or every custom role</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Updates a Role definition.</p>
+<p class="firstline">Updates the definition of a custom Role.</p>
<p class="toc_element">
<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Undelete a Role, bringing it back in its previous state.</p>
+<p class="firstline">Undeletes a custom Role.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
- <pre>Creates a new Role.
+ <pre>Creates a new custom Role.
Args:
parent: string, The `parent` parameter's value depends on the target resource for the
@@ -125,28 +125,32 @@
The object takes the form of:
{ # The request to create a new role.
- "roleId": "A String", # The role ID to use for this role.
"role": { # A role in the Identity and Access Management API. # The Role resource to create.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- },
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ },
+ "roleId": "A String", # The role ID to use for this role.
+ #
+ # A role ID may contain alphanumeric characters, underscores (`_`), and
+ # periods (`.`). It must contain a minimum of 3 characters and a maximum of
+ # 64 characters.
}
x__xgafv: string, V1 error format.
@@ -158,37 +162,47 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- }</pre>
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ }</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code>
- <pre>Soft deletes a role. The role is suspended and cannot be used to create new
-IAM Policy Bindings.
-The Role will not be included in `ListRoles()` unless `show_deleted` is set
-in the `ListRolesRequest`. The Role contains the deleted boolean set.
-Existing Bindings remains, but are inactive. The Role can be undeleted
-within 7 days. After 7 days the Role is deleted and all Bindings associated
-with the role are removed.
+ <pre>Deletes a custom Role.
+
+When you delete a custom role, the following changes occur immediately:
+
+* You cannot bind a member to the custom role in an IAM
+Policy.
+* Existing bindings to the custom role are not changed, but they have no
+effect.
+* By default, the response from ListRoles does not include the custom
+role.
+
+You have 7 days to undelete the custom role. After 7 days, the following
+changes occur:
+
+* The custom role is permanently deleted and cannot be recovered.
+* If an IAM policy contains a binding to the custom role, the binding is
+permanently removed.
Args:
name: string, The `name` parameter's value depends on the target resource for the
@@ -221,31 +235,31 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- }</pre>
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ }</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
- <pre>Gets a Role definition.
+ <pre>Gets the definition of a Role.
Args:
name: string, The `name` parameter's value depends on the target resource for the
@@ -284,31 +298,32 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- }</pre>
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, showDeleted=None, x__xgafv=None)</code>
- <pre>Lists the Roles defined on a resource.
+ <code class="details" id="list">list(parent, pageSize=None, view=None, showDeleted=None, pageToken=None, x__xgafv=None)</code>
+ <pre>Lists every predefined Role that IAM supports, or every custom role
+that is defined for an organization or project.
Args:
parent: string, The `parent` parameter's value depends on the target resource for the
@@ -338,13 +353,15 @@
Note: Wildcard (*) values are invalid; you must specify a complete project
ID or organization ID. (required)
- pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
pageSize: integer, Optional limit on the number of roles to include in the response.
+
+The default is 300, and the maximum is 1,000.
view: string, Optional view for the returned Role objects. When `FULL` is specified,
the `includedPermissions` field is returned, which includes a list of all
permissions in the role. The default value is `BASIC`, which does not
return the `includedPermissions` field.
showDeleted: boolean, Include Roles that have been deleted.
+ pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -354,31 +371,31 @@
An object of the form:
{ # The response containing the roles defined under a resource.
- "roles": [ # The Roles defined on this resource.
- { # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- },
- ],
"nextPageToken": "A String", # To retrieve the next page of results, set
# `ListRolesRequest.page_token` to this value.
+ "roles": [ # The Roles defined on this resource.
+ { # A role in the Identity and Access Management API.
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ },
+ ],
}</pre>
</div>
@@ -398,7 +415,7 @@
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
- <pre>Updates a Role definition.
+ <pre>Updates the definition of a custom Role.
Args:
name: string, The `name` parameter's value depends on the target resource for the
@@ -425,26 +442,26 @@
The object takes the form of:
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
-}
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ }
updateMask: string, A mask describing which fields in the Role have changed.
x__xgafv: string, V1 error format.
@@ -456,31 +473,31 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- }</pre>
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ }</pre>
</div>
<div class="method">
<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
- <pre>Undelete a Role, bringing it back in its previous state.
+ <pre>Undeletes a custom Role.
Args:
name: string, The `name` parameter's value depends on the target resource for the
@@ -519,26 +536,26 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "deleted": True or False, # The current deleted state of the role. This field is read only.
- # It will be ignored in calls to CreateRole and UpdateRole.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
- # is limited to 100 UTF-8 bytes.
- "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
- "A String",
- ],
- "description": "A String", # Optional. A human-readable description for the role.
- "etag": "A String", # Used to perform a consistent read-modify-write.
- "stage": "A String", # 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": "A 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 predefined roles
- # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
- }</pre>
+ "name": "A 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 predefined roles
+ # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
+ "deleted": True or False, # The current deleted state of the role. This field is read only.
+ # It will be ignored in calls to CreateRole and UpdateRole.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
+ # is limited to 100 UTF-8 bytes.
+ "description": "A String", # Optional. A human-readable description for the role.
+ "etag": "A String", # Used to perform a consistent read-modify-write.
+ "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
+ "A String",
+ ],
+ "stage": "A String", # 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.
+ }</pre>
</div>
</body></html>
\ No newline at end of file