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">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="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a Role definition.</p>
80<p class="toc_element">
81  <code><a href="#list">list(parent=None, pageSize=None, showDeleted=None, pageToken=None, x__xgafv=None, view=None)</a></code></p>
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">
87  <code><a href="#queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</a></code></p>
88<p class="firstline">Queries roles that can be granted on a particular resource.</p>
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>
92<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="get">get(name, x__xgafv=None)</code>
95  <pre>Gets a Role definition.
96
97Args:
98  name: string, The resource name of the role in one of the following formats:
99`roles/{ROLE_NAME}`
100`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`
101`projects/{PROJECT_ID}/roles/{ROLE_NAME}` (required)
102  x__xgafv: string, V1 error format.
103    Allowed values
104      1 - v1 error format
105      2 - v2 error format
106
107Returns:
108  An object of the form:
109
110    { # A role in the Identity and Access Management API.
111    "description": "A String", # Optional.  A human-readable description for the role.
112    "title": "A String", # Optional.  A human-readable title for the role.  Typically this
113        # is limited to 100 UTF-8 bytes.
114    "deleted": True or False, # The current deleted state of the role. This field is read only.
115        # It will be ignored in calls to CreateRole and UpdateRole.
116    "etag": "A String", # Used to perform a consistent read-modify-write.
117    "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
118      "A String",
119    ],
120    "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
121        # selected for a role, the `stage` field will not be included in the
122        # returned definition for the role.
123    "name": "A String", # The name of the role.
124        #
125        # When Role is used in CreateRole, the role name must not be set.
126        #
127        # When Role is used in output and other input such as UpdateRole, the role
128        # name is the complete path, e.g., roles/logging.viewer for curated roles
129        # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
130  }</pre>
131</div>
132
133<div class="method">
134    <code class="details" id="list">list(parent=None, pageSize=None, showDeleted=None, pageToken=None, x__xgafv=None, view=None)</code>
135  <pre>Lists the Roles defined on a resource.
136
137Args:
138  parent: string, The resource name of the parent resource in one of the following formats:
139`` (empty string) -- this refers to curated roles.
140`organizations/{ORGANIZATION_ID}`
141`projects/{PROJECT_ID}`
142  pageSize: integer, Optional limit on the number of roles to include in the response.
143  showDeleted: boolean, Include Roles that have been deleted.
144  pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
145  x__xgafv: string, V1 error format.
146    Allowed values
147      1 - v1 error format
148      2 - v2 error format
149  view: string, Optional view for the returned Role objects. When `FULL` is specified,
150the `includedPermissions` field is returned, which includes a list of all
151permissions in the role. The default value is `BASIC`, which does not
152return the `includedPermissions` field.
153
154Returns:
155  An object of the form:
156
157    { # The response containing the roles defined under a resource.
158    "nextPageToken": "A String", # To retrieve the next page of results, set
159        # `ListRolesRequest.page_token` to this value.
160    "roles": [ # The Roles defined on this resource.
161      { # A role in the Identity and Access Management API.
162        "description": "A String", # Optional.  A human-readable description for the role.
163        "title": "A String", # Optional.  A human-readable title for the role.  Typically this
164            # is limited to 100 UTF-8 bytes.
165        "deleted": True or False, # The current deleted state of the role. This field is read only.
166            # It will be ignored in calls to CreateRole and UpdateRole.
167        "etag": "A String", # Used to perform a consistent read-modify-write.
168        "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
169          "A String",
170        ],
171        "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
172            # selected for a role, the `stage` field will not be included in the
173            # returned definition for the role.
174        "name": "A String", # The name of the role.
175            #
176            # When Role is used in CreateRole, the role name must not be set.
177            #
178            # When Role is used in output and other input such as UpdateRole, the role
179            # name is the complete path, e.g., roles/logging.viewer for curated roles
180            # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
181      },
182    ],
183  }</pre>
184</div>
185
186<div class="method">
187    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
188  <pre>Retrieves the next page of results.
189
190Args:
191  previous_request: The request for the previous page. (required)
192  previous_response: The response from the request for the previous page. (required)
193
194Returns:
195  A request object that you can call 'execute()' on to request the next
196  page. Returns None if there are no more items in the collection.
197    </pre>
198</div>
199
200<div class="method">
201    <code class="details" id="queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</code>
202  <pre>Queries roles that can be granted on a particular resource.
203A role is grantable if it can be used as the role in a binding for a policy
204for that resource.
205
206Args:
207  body: object, The request body. (required)
208    The object takes the form of:
209
210{ # The grantable role query request.
211    "pageToken": "A String", # Optional pagination token returned in an earlier
212        # QueryGrantableRolesResponse.
213    "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles.
214        #
215        # The name follows the Google Cloud Platform resource format.
216        # For example, a Cloud Platform project with id `my-project` will be named
217        # `//cloudresourcemanager.googleapis.com/projects/my-project`.
218    "pageSize": 42, # Optional limit on the number of roles to include in the response.
219    "view": "A String",
220  }
221
222  x__xgafv: string, V1 error format.
223    Allowed values
224      1 - v1 error format
225      2 - v2 error format
226
227Returns:
228  An object of the form:
229
230    { # The grantable role query response.
231    "nextPageToken": "A String", # To retrieve the next page of results, set
232        # `QueryGrantableRolesRequest.page_token` to this value.
233    "roles": [ # The list of matching roles.
234      { # A role in the Identity and Access Management API.
235        "description": "A String", # Optional.  A human-readable description for the role.
236        "title": "A String", # Optional.  A human-readable title for the role.  Typically this
237            # is limited to 100 UTF-8 bytes.
238        "deleted": True or False, # The current deleted state of the role. This field is read only.
239            # It will be ignored in calls to CreateRole and UpdateRole.
240        "etag": "A String", # Used to perform a consistent read-modify-write.
241        "includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
242          "A String",
243        ],
244        "stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
245            # selected for a role, the `stage` field will not be included in the
246            # returned definition for the role.
247        "name": "A String", # The name of the role.
248            #
249            # When Role is used in CreateRole, the role name must not be set.
250            #
251            # When Role is used in output and other input such as UpdateRole, the role
252            # name is the complete path, e.g., roles/logging.viewer for curated roles
253            # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
254      },
255    ],
256  }</pre>
257</div>
258
259<div class="method">
260    <code class="details" id="queryGrantableRoles_next">queryGrantableRoles_next(previous_request, previous_response)</code>
261  <pre>Retrieves the next page of results.
262
263Args:
264  previous_request: The request for the previous page. (required)
265  previous_response: The response from the request for the previous page. (required)
266
267Returns:
268  A request object that you can call 'execute()' on to request the next
269  page. Returns None if there are no more items in the collection.
270    </pre>
271</div>
272
273</body></html>