Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / iam_v1.permissions.html
blob: be7648a1049ef2e7e0855976881619428458955e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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">Identity and Access Management (IAM) API</a> . <a href="iam_v1.permissions.html">permissions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#queryTestablePermissions">queryTestablePermissions(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Lists every permission that you can test on a resource. A permission is testable if you can check whether a member has that permission on the resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#queryTestablePermissions_next">queryTestablePermissions_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code class="details" id="queryTestablePermissions">queryTestablePermissions(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <pre>Lists every permission that you can test on a resource. A permission is testable if you can check whether a member has that permission on the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
96Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 The object takes the form of:
99
100{ # A request to get permissions which can be tested on a resource.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]101 &quot;pageSize&quot;: 42, # Optional limit on the number of permissions to include in the response. The default is 100, and the maximum is 1,000.
102 &quot;fullResourceName&quot;: &quot;A String&quot;, # Required. The full resource name to query from the list of testable permissions. 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`.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]103 &quot;pageToken&quot;: &quot;A String&quot;, # Optional pagination token returned in an earlier QueryTestablePermissionsRequest.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104 }
105
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # The response containing permissions which can be tested on a resource.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]115 &quot;nextPageToken&quot;: &quot;A String&quot;, # To retrieve the next page of results, set `QueryTestableRolesRequest.page_token` to this value.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]116 &quot;permissions&quot;: [ # The Permissions testable on the requested resource.
117 { # A permission which can be included by a role.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 &quot;onlyInPredefinedRoles&quot;: True or False,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]119 &quot;apiDisabled&quot;: True or False, # The service API associated with the permission is not enabled.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]120 &quot;primaryPermission&quot;: &quot;A String&quot;, # The preferred name for this permission. If present, then this permission is an alias of, and equivalent to, the listed primary_permission.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]121 &quot;title&quot;: &quot;A String&quot;, # The title of this Permission.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]122 &quot;stage&quot;: &quot;A String&quot;, # The current launch stage of the permission.
123 &quot;customRolesSupportLevel&quot;: &quot;A String&quot;, # The current custom role support level.
124 &quot;description&quot;: &quot;A String&quot;, # A brief description of what this Permission is used for. This permission can ONLY be used in predefined roles.
125 &quot;name&quot;: &quot;A String&quot;, # The name of this Permission.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 },
127 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 }</pre>
129</div>
130
131<div class="method">
132 <code class="details" id="queryTestablePermissions_next">queryTestablePermissions_next(previous_request, previous_response)</code>
133 <pre>Retrieves the next page of results.
134
135Args:
136 previous_request: The request for the previous page. (required)
137 previous_response: The response from the request for the previous page. (required)
138
139Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 page. Returns None if there are no more items in the collection.
142 </pre>
143</div>
144
145</body></html>