blob: 887b98fed40b9905ba374430487f3bc8d73032be [file] [log] [blame]
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -07001<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 -040079<p class="firstline">Queries roles that can be granted on a particular resource.</p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070080<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="queryGrantableRoles">queryGrantableRoles(body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040083 <pre>Queries roles that can be granted on a particular resource.
84A role is grantable if it can be used as the role in a binding for a policy
85for that resource.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070086
87Args:
88 body: object, The request body. (required)
89 The object takes the form of:
90
91{ # The grantable role query request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040092 "fullResourceName": "A String", # Required. The full resource name to query from the list of grantable roles.
93 #
94 # The name follows the Google Cloud Platform resource format.
95 # For example, a Cloud Platform project with id `my-project` will be named
96 # `//cloudresourcemanager.googleapis.com/projects/my-project`.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -070097 }
98
99 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700103
104Returns:
105 An object of the form:
106
107 { # The grantable role query response.
108 "roles": [ # The list of matching roles.
109 { # A role in the Identity and Access Management API.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400110 "title": "A String", # Optional. A human-readable title for the role. Typically this
111 # is limited to 100 UTF-8 bytes.
112 "name": "A String", # The name of the role.
113 #
114 # When Role is used in CreateRole, the role name must not be set.
115 #
116 # When Role is used in output and other input such as UpdateRole, the role
117 # name is the complete path, e.g., roles/logging.viewer for curated roles
118 # and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
119 "description": "A String", # Optional. A human-readable description for the role.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700120 },
121 ],
122 }</pre>
123</div>
124
125</body></html>