blob: 5ac5e6c53c22848a6d9000c24ce49df5c3f2e5b3 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="iam_v1.html">Google Identity and Access Management (IAM) API</a> . <a href="iam_v1.roles.html">roles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</a></code></p>
<p class="firstline">Queries roles that can be granted on a particular resource.</p>
<p class="toc_element">
<code><a href="#queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</code>
<pre>Queries roles that can be granted on a particular resource.
A role is grantable if it can be used as the role in a binding for a policy
for that resource.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # The grantable role query request.
"pageToken": "A String", # Optional pagination token returned in an earlier
# QueryGrantableRolesResponse.
"fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles.
#
# The name follows the Google Cloud Platform resource format.
# For example, a Cloud Platform project with id `my-project` will be named
# `//cloudresourcemanager.googleapis.com/projects/my-project`.
"pageSize": 42, # Optional limit on the number of roles to include in the response.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The grantable role query response.
"nextPageToken": "A String", # To retrieve the next page of results, set
# `QueryGrantableRolesRequest.page_token` to this value.
"roles": [ # The list of matching roles.
{ # A role in the Identity and Access Management API.
"title": "A String", # Optional. A human-readable title for the role. Typically this
# is limited to 100 UTF-8 bytes.
"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 curated roles
# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
"description": "A String", # Optional. A human-readable description for the role.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>