Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 02bae1c909ec28088ebbc4007f3ef9b968b55e0a / . / docs / dyn / iam_v1.roles.html
blob: 5ac5e6c53c22848a6d9000c24ce49df5c3f2e5b3 [file] [log] [blame]
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="iam_v1.html">Google Identity and Access Management (IAM) API</a> . <a href="iam_v1.roles.html">roles</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Queries roles that can be granted on a particular resource.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86 <pre>Queries roles that can be granted on a particular resource.
87A role is grantable if it can be used as the role in a binding for a policy
88for that resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]89
90Args:
91 body: object, The request body. (required)
92 The object takes the form of:
93
94{ # The grantable role query request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]95 "pageToken": "A String", # Optional pagination token returned in an earlier
96 # QueryGrantableRolesResponse.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97 "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles.
98 #
99 # The name follows the Google Cloud Platform resource format.
100 # For example, a Cloud Platform project with id `my-project` will be named
101 # `//cloudresourcemanager.googleapis.com/projects/my-project`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]102 "pageSize": 42, # Optional limit on the number of roles to include in the response.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]103 }
104
105 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]109
110Returns:
111 An object of the form:
112
113 { # The grantable role query response.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]114 "nextPageToken": "A String", # To retrieve the next page of results, set
115 # `QueryGrantableRolesRequest.page_token` to this value.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]116 "roles": [ # The list of matching roles.
117 { # A role in the Identity and Access Management API.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]118 "title": "A String", # Optional. A human-readable title for the role. Typically this
119 # is limited to 100 UTF-8 bytes.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120 "name": "A String", # The name of the role.
121 #
122 # When Role is used in CreateRole, the role name must not be set.
123 #
124 # When Role is used in output and other input such as UpdateRole, the role
125 # name is the complete path, e.g., roles/logging.viewer for curated roles
126 # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]127 "description": "A String", # Optional. A human-readable description for the role.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]128 },
129 ],
130 }</pre>
131</div>
132
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]133<div class="method">
134 <code class="details" id="queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</code>
135 <pre>Retrieves the next page of results.
136
137Args:
138 previous_request: The request for the previous page. (required)
139 previous_response: The response from the request for the previous page. (required)
140
141Returns:
142 A request object that you can call 'execute()' on to request the next
143 page. Returns None if there are no more items in the collection.
144 </pre>
145</div>
146
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]147</body></html>