Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / iam_v1.roles.html
blob: 331069386f6e2a269f8478b20a4e41ded4d3e143 [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.roles.html">roles</a></h1>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a Role definition.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#list">list(pageSize=None, parent=None, showDeleted=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Lists the Roles defined on a resource.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#queryGrantableRoles">queryGrantableRoles(body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Queries roles that can be granted on a particular resource.</p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]89<p class="toc_element">
90 <code><a href="#queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94 <code class="details" id="get">get(name, x__xgafv=None)</code>
95 <pre>Gets a Role definition.
96
97Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 name: string, The `name` parameter's value depends on the target resource for the
99request, namely
100[`roles`](/iam/reference/rest/v1/roles),
101[`projects`](/iam/reference/rest/v1/projects.roles), or
102[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
103resource type's `name` value format is described below:
104
105* [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`.
106 This method returns results from all
107 [predefined roles](/iam/docs/understanding-roles#predefined_roles) in
108 Cloud IAM. Example request URL:
109 `https://iam.googleapis.com/v1/roles/{ROLE_NAME}`
110
111* [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get):
112 `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only
113 [custom roles](/iam/docs/understanding-custom-roles) that have been
114 created at the project level. Example request URL:
115 `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
116
117* [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get):
118 `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
119 returns only [custom roles](/iam/docs/understanding-custom-roles) that
120 have been created at the organization level. Example request URL:
121 `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
122
123Note: Wildcard (*) values are invalid; you must specify a complete project
124ID or organization ID. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
129
130Returns:
131 An object of the form:
132
133 { # A role in the Identity and Access Management API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]134 "description": "A String", # Optional. A human-readable description for the role.
135 "title": "A String", # Optional. A human-readable title for the role. Typically this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 # is limited to 100 UTF-8 bytes.
137 "deleted": True or False, # The current deleted state of the role. This field is read only.
138 # It will be ignored in calls to CreateRole and UpdateRole.
139 "etag": "A String", # Used to perform a consistent read-modify-write.
140 "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
141 "A String",
142 ],
143 "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
144 # selected for a role, the `stage` field will not be included in the
145 # returned definition for the role.
146 "name": "A String", # The name of the role.
147 #
148 # When Role is used in CreateRole, the role name must not be set.
149 #
150 # When Role is used in output and other input such as UpdateRole, the role
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]151 # name is the complete path, e.g., roles/logging.viewer for predefined roles
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]152 # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
153 }</pre>
154</div>
155
156<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 <code class="details" id="list">list(pageSize=None, parent=None, showDeleted=None, pageToken=None, x__xgafv=None, view=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 <pre>Lists the Roles defined on a resource.
159
160Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 pageSize: integer, Optional limit on the number of roles to include in the response.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]162 parent: string, The `parent` parameter's value depends on the target resource for the
163request, namely
164[`roles`](/iam/reference/rest/v1/roles),
165[`projects`](/iam/reference/rest/v1/projects.roles), or
166[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
167resource type's `parent` value format is described below:
168
169* [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string.
170 This method doesn't require a resource; it simply returns all
171 [predefined roles](/iam/docs/understanding-roles#predefined_roles) in
172 Cloud IAM. Example request URL:
173 `https://iam.googleapis.com/v1/roles`
174
175* [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list):
176 `projects/{PROJECT_ID}`. This method lists all project-level
177 [custom roles](/iam/docs/understanding-custom-roles).
178 Example request URL:
179 `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
180
181* [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list):
182 `organizations/{ORGANIZATION_ID}`. This method lists all
183 organization-level [custom roles](/iam/docs/understanding-custom-roles).
184 Example request URL:
185 `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
186
187Note: Wildcard (*) values are invalid; you must specify a complete project
188ID or organization ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 showDeleted: boolean, Include Roles that have been deleted.
190 pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
191 x__xgafv: string, V1 error format.
192 Allowed values
193 1 - v1 error format
194 2 - v2 error format
195 view: string, Optional view for the returned Role objects. When `FULL` is specified,
196the `includedPermissions` field is returned, which includes a list of all
197permissions in the role. The default value is `BASIC`, which does not
198return the `includedPermissions` field.
199
200Returns:
201 An object of the form:
202
203 { # The response containing the roles defined under a resource.
204 "nextPageToken": "A String", # To retrieve the next page of results, set
205 # `ListRolesRequest.page_token` to this value.
206 "roles": [ # The Roles defined on this resource.
207 { # A role in the Identity and Access Management API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]208 "description": "A String", # Optional. A human-readable description for the role.
209 "title": "A String", # Optional. A human-readable title for the role. Typically this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 # is limited to 100 UTF-8 bytes.
211 "deleted": True or False, # The current deleted state of the role. This field is read only.
212 # It will be ignored in calls to CreateRole and UpdateRole.
213 "etag": "A String", # Used to perform a consistent read-modify-write.
214 "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
215 "A String",
216 ],
217 "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
218 # selected for a role, the `stage` field will not be included in the
219 # returned definition for the role.
220 "name": "A String", # The name of the role.
221 #
222 # When Role is used in CreateRole, the role name must not be set.
223 #
224 # When Role is used in output and other input such as UpdateRole, the role
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 # name is the complete path, e.g., roles/logging.viewer for predefined roles
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
227 },
228 ],
229 }</pre>
230</div>
231
232<div class="method">
233 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
234 <pre>Retrieves the next page of results.
235
236Args:
237 previous_request: The request for the previous page. (required)
238 previous_response: The response from the request for the previous page. (required)
239
240Returns:
241 A request object that you can call 'execute()' on to request the next
242 page. Returns None if there are no more items in the collection.
243 </pre>
244</div>
245
246<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]247 <code class="details" id="queryGrantableRoles">queryGrantableRoles(body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]248 <pre>Queries roles that can be granted on a particular resource.
249A role is grantable if it can be used as the role in a binding for a policy
250for that resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]251
252Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]253 body: object, The request body.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]254 The object takes the form of:
255
256{ # The grantable role query request.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]257 "pageToken": "A String", # Optional pagination token returned in an earlier
258 # QueryGrantableRolesResponse.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]259 "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles.
260 #
261 # The name follows the Google Cloud Platform resource format.
262 # For example, a Cloud Platform project with id `my-project` will be named
263 # `//cloudresourcemanager.googleapis.com/projects/my-project`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]264 "pageSize": 42, # Optional limit on the number of roles to include in the response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 "view": "A String",
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]266 }
267
268 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]272
273Returns:
274 An object of the form:
275
276 { # The grantable role query response.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]277 "nextPageToken": "A String", # To retrieve the next page of results, set
278 # `QueryGrantableRolesRequest.page_token` to this value.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]279 "roles": [ # The list of matching roles.
280 { # A role in the Identity and Access Management API.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 "description": "A String", # Optional. A human-readable description for the role.
282 "title": "A String", # Optional. A human-readable title for the role. Typically this
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]283 # is limited to 100 UTF-8 bytes.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]284 "deleted": True or False, # The current deleted state of the role. This field is read only.
285 # It will be ignored in calls to CreateRole and UpdateRole.
286 "etag": "A String", # Used to perform a consistent read-modify-write.
287 "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
288 "A String",
289 ],
290 "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
291 # selected for a role, the `stage` field will not be included in the
292 # returned definition for the role.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]293 "name": "A String", # The name of the role.
294 #
295 # When Role is used in CreateRole, the role name must not be set.
296 #
297 # When Role is used in output and other input such as UpdateRole, the role
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]298 # name is the complete path, e.g., roles/logging.viewer for predefined roles
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]299 # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]300 },
301 ],
302 }</pre>
303</div>
304
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]305<div class="method">
306 <code class="details" id="queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</code>
307 <pre>Retrieves the next page of results.
308
309Args:
310 previous_request: The request for the previous page. (required)
311 previous_response: The response from the request for the previous page. (required)
312
313Returns:
314 A request object that you can call 'execute()' on to request the next
315 page. Returns None if there are no more items in the collection.
316 </pre>
317</div>
318
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]319</body></html>