chore: regens API reference docs (#889)
diff --git a/docs/dyn/iam_v1.projects.roles.html b/docs/dyn/iam_v1.projects.roles.html
index ed643e0..fc43338 100644
--- a/docs/dyn/iam_v1.projects.roles.html
+++ b/docs/dyn/iam_v1.projects.roles.html
@@ -75,7 +75,7 @@
<h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.roles.html">roles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Role.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p>
@@ -90,28 +90,45 @@
<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, updateMask=None, x__xgafv=None)</a></code></p>
+ <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="toc_element">
- <code><a href="#undelete">undelete(name, body, x__xgafv=None)</a></code></p>
+ <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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new Role.
Args:
- parent: string, The resource name of the parent resource in one of the following formats:
-`organizations/{ORGANIZATION_ID}`
-`projects/{PROJECT_ID}` (required)
- body: object, The request body. (required)
+ parent: string, The `parent` parameter's value depends on the target resource for the
+request, namely
+[`projects`](/iam/reference/rest/v1/projects.roles) or
+[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
+resource type's `parent` value format is described below:
+
+* [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create):
+ `projects/{PROJECT_ID}`. This method creates project-level
+ [custom roles](/iam/docs/understanding-custom-roles).
+ Example request URL:
+ `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
+
+* [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/create):
+ `organizations/{ORGANIZATION_ID}`. This method creates organization-level
+ [custom roles](/iam/docs/understanding-custom-roles). Example request
+ URL:
+ `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
+
+Note: Wildcard (*) values are invalid; you must specify a complete project
+ID or organization ID. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request to create a new role.
- "roleId": "A String", # The role id to use for this 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.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -127,7 +144,7 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
},
}
@@ -141,8 +158,8 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -158,7 +175,7 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
}</pre>
</div>
@@ -174,9 +191,26 @@
with the role are removed.
Args:
- name: string, The resource name of the role in one of the following formats:
-`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`
-`projects/{PROJECT_ID}/roles/{ROLE_NAME}` (required)
+ name: string, The `name` parameter's value depends on the target resource for the
+request, namely
+[`projects`](/iam/reference/rest/v1/projects.roles) or
+[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
+resource type's `name` value format is described below:
+
+* [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete):
+ `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only
+ [custom roles](/iam/docs/understanding-custom-roles) that have been
+ created at the project level. Example request URL:
+ `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
+
+* [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/delete):
+ `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
+ deletes only [custom roles](/iam/docs/understanding-custom-roles) that
+ have been created at the organization level. Example request URL:
+ `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
+
+Note: Wildcard (*) values are invalid; you must specify a complete project
+ID or organization ID. (required)
etag: string, Used to perform a consistent read-modify-write.
x__xgafv: string, V1 error format.
Allowed values
@@ -187,8 +221,8 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -204,7 +238,7 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
}</pre>
</div>
@@ -214,10 +248,33 @@
<pre>Gets a Role definition.
Args:
- name: string, 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}` (required)
+ name: string, The `name` parameter's value depends on the target resource for the
+request, namely
+[`roles`](/iam/reference/rest/v1/roles),
+[`projects`](/iam/reference/rest/v1/projects.roles), or
+[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
+resource type's `name` value format is described below:
+
+* [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`.
+ This method returns results from all
+ [predefined roles](/iam/docs/understanding-roles#predefined_roles) in
+ Cloud IAM. Example request URL:
+ `https://iam.googleapis.com/v1/roles/{ROLE_NAME}`
+
+* [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get):
+ `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only
+ [custom roles](/iam/docs/understanding-custom-roles) that have been
+ created at the project level. Example request URL:
+ `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
+
+* [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get):
+ `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
+ returns only [custom roles](/iam/docs/understanding-custom-roles) that
+ have been created at the organization level. Example request URL:
+ `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
+
+Note: Wildcard (*) values are invalid; you must specify a complete project
+ID or organization ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -227,8 +284,8 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -244,7 +301,7 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
}</pre>
</div>
@@ -254,10 +311,33 @@
<pre>Lists the Roles defined on a resource.
Args:
- parent: string, The resource name of the parent resource in one of the following formats:
-`` (empty string) -- this refers to curated roles.
-`organizations/{ORGANIZATION_ID}`
-`projects/{PROJECT_ID}` (required)
+ parent: string, The `parent` parameter's value depends on the target resource for the
+request, namely
+[`roles`](/iam/reference/rest/v1/roles),
+[`projects`](/iam/reference/rest/v1/projects.roles), or
+[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
+resource type's `parent` value format is described below:
+
+* [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string.
+ This method doesn't require a resource; it simply returns all
+ [predefined roles](/iam/docs/understanding-roles#predefined_roles) in
+ Cloud IAM. Example request URL:
+ `https://iam.googleapis.com/v1/roles`
+
+* [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list):
+ `projects/{PROJECT_ID}`. This method lists all project-level
+ [custom roles](/iam/docs/understanding-custom-roles).
+ Example request URL:
+ `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
+
+* [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list):
+ `organizations/{ORGANIZATION_ID}`. This method lists all
+ organization-level [custom roles](/iam/docs/understanding-custom-roles).
+ Example request URL:
+ `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
+
+Note: Wildcard (*) values are invalid; you must specify a complete project
+ID or organization ID. (required)
pageSize: integer, Optional limit on the number of roles to include in the response.
showDeleted: boolean, Include Roles that have been deleted.
pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
@@ -278,8 +358,8 @@
# `ListRolesRequest.page_token` to this value.
"roles": [ # The Roles defined on this resource.
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -295,7 +375,7 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
},
],
@@ -317,20 +397,36 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a Role definition.
Args:
- name: string, 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}` (required)
- body: object, The request body. (required)
+ name: string, The `name` parameter's value depends on the target resource for the
+request, namely
+[`projects`](/iam/reference/rest/v1/projects.roles) or
+[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
+resource type's `name` value format is described below:
+
+* [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch):
+ `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only
+ [custom roles](/iam/docs/understanding-custom-roles) that have been
+ created at the project level. Example request URL:
+ `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
+
+* [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch):
+ `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
+ updates only [custom roles](/iam/docs/understanding-custom-roles) that
+ have been created at the organization level. Example request URL:
+ `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
+
+Note: Wildcard (*) values are invalid; you must specify a complete project
+ID or organization ID. (required)
+ body: object, The request body.
The object takes the form of:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -346,7 +442,7 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
}
@@ -360,8 +456,8 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -377,20 +473,37 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
}</pre>
</div>
<div class="method">
- <code class="details" id="undelete">undelete(name, body, x__xgafv=None)</code>
+ <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
<pre>Undelete a Role, bringing it back in its previous state.
Args:
- name: string, The resource name of the role in one of the following formats:
-`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`
-`projects/{PROJECT_ID}/roles/{ROLE_NAME}` (required)
- body: object, The request body. (required)
+ name: string, The `name` parameter's value depends on the target resource for the
+request, namely
+[`projects`](/iam/reference/rest/v1/projects.roles) or
+[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
+resource type's `name` value format is described below:
+
+* [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete):
+ `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes
+ only [custom roles](/iam/docs/understanding-custom-roles) that have been
+ created at the project level. Example request URL:
+ `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
+
+* [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations.roles/undelete):
+ `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
+ undeletes only [custom roles](/iam/docs/understanding-custom-roles) that
+ have been created at the organization level. Example request URL:
+ `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
+
+Note: Wildcard (*) values are invalid; you must specify a complete project
+ID or organization ID. (required)
+ body: object, The request body.
The object takes the form of:
{ # The request to undelete an existing role.
@@ -406,8 +519,8 @@
An object of the form:
{ # A role in the Identity and Access Management API.
- "description": "A String", # Optional. A human-readable description for the role.
- "title": "A String", # Optional. A human-readable title for the role. Typically this
+ "description": "A String", # Optional. A human-readable description for the role.
+ "title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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.
@@ -423,7 +536,7 @@
# 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
+ # name is the complete path, e.g., roles/logging.viewer for predefined roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
}</pre>
</div>