Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / iam_v1.permissions.html
blob: d917e3bef94233be0c231777d223acc34bb48b5a [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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#queryTestablePermissions">queryTestablePermissions(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Lists the permissions testable on a resource.</p>
80<p class="toc_element">
81 <code><a href="#queryTestablePermissions_next">queryTestablePermissions_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]85 <code class="details" id="queryTestablePermissions">queryTestablePermissions(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <pre>Lists the permissions testable on a resource.
87A permission is testable if it can be tested for an identity on a resource.
88
89Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 The object takes the form of:
92
93{ # A request to get permissions which can be tested on a resource.
94 "pageToken": "A String", # Optional pagination token returned in an earlier
95 # QueryTestablePermissionsRequest.
96 "fullResourceName": "A String", # Required. The full resource name to query from the list of testable
97 # permissions.
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`.
102 "pageSize": 42, # Optional limit on the number of permissions to include in the response.
103 }
104
105 x__xgafv: string, V1 error format.
106 Allowed values
107 1 - v1 error format
108 2 - v2 error format
109
110Returns:
111 An object of the form:
112
113 { # The response containing permissions which can be tested on a resource.
114 "nextPageToken": "A String", # To retrieve the next page of results, set
115 # `QueryTestableRolesRequest.page_token` to this value.
116 "permissions": [ # The Permissions testable on the requested resource.
117 { # A permission which can be included by a role.
118 "apiDisabled": True or False, # The service API associated with the permission is not enabled.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 "description": "A String", # A brief description of what this Permission is used for.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120 # This permission can ONLY be used in predefined roles.
121 "title": "A String", # The title of this Permission.
122 "primaryPermission": "A String", # The preferred name for this permission. If present, then this permission is
123 # an alias of, and equivalent to, the listed primary_permission.
124 "name": "A String", # The name of this Permission.
125 "onlyInPredefinedRoles": True or False,
126 "customRolesSupportLevel": "A String", # The current custom role support level.
127 "stage": "A String", # The current launch stage of the permission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 },
129 ],
130 }</pre>
131</div>
132
133<div class="method">
134 <code class="details" id="queryTestablePermissions_next">queryTestablePermissions_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
147</body></html>