Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame^] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.policies.html">policies</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Gets the access control policy for a resource.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#set">set(body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#test">test(body=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="get">get(body=None, x__xgafv=None)</code> |
| 89 | <pre>Gets the access control policy for a resource. |
| 90 | Returns an empty policy if the resource exists and does not have a policy |
| 91 | set. |
| 92 | |
| 93 | Args: |
| 94 | body: object, The request body. |
| 95 | The object takes the form of: |
| 96 | |
| 97 | { # Request message for `GetPolicy` method. |
| 98 | "resource": "A String", # Required. The resource for which the policy is being requested. |
| 99 | } |
| 100 | |
| 101 | x__xgafv: string, V1 error format. |
| 102 | Allowed values |
| 103 | 1 - v1 error format |
| 104 | 2 - v2 error format |
| 105 | |
| 106 | Returns: |
| 107 | An object of the form: |
| 108 | |
| 109 | { # Defines an access control policy to the resources. |
| 110 | "etag": "A String", # The [etag] is used for optimistic concurrency control as a way to |
| 111 | # help prevent simultaneous updates of a policy from overwriting |
| 112 | # each other. It is strongly suggested that systems make use of |
| 113 | # the [etag] in the read-modify-write cycle to perform policy |
| 114 | # updates in order to avoid race conditions: An [etag] is returned |
| 115 | # in the response to [GetPolicy], and systems are expected to put |
| 116 | # that etag in the request to [SetPolicy] to ensure that their |
| 117 | # change will be applied to the same version of the policy. |
| 118 | # |
| 119 | # If no [etag] is provided in the call to [SetPolicy], then the |
| 120 | # existing policy is overwritten blindly. |
| 121 | "assignments": [ |
| 122 | { # Associates `members` with a `role`. |
| 123 | "members": [ # The identities the role is assigned to. It can have the following |
| 124 | # values: |
| 125 | # |
| 126 | # * `{user_email}`: An email address that represents a specific |
| 127 | # Google account. For example: `alice@gmail.com`. |
| 128 | # |
| 129 | # * `{group_email}`: An email address that represents a Google |
| 130 | # group. For example, `viewers@gmail.com`. |
| 131 | "A String", |
| 132 | ], |
| 133 | "role": "A String", # Required. Role that is assigned to `members`. |
| 134 | }, |
| 135 | ], |
| 136 | }</pre> |
| 137 | </div> |
| 138 | |
| 139 | <div class="method"> |
| 140 | <code class="details" id="set">set(body=None, x__xgafv=None)</code> |
| 141 | <pre>Sets the access control policy on the specified resource. Replaces any |
| 142 | existing policy. |
| 143 | |
| 144 | Args: |
| 145 | body: object, The request body. |
| 146 | The object takes the form of: |
| 147 | |
| 148 | { # Request message for `SetPolicy` method. |
| 149 | "resource": "A String", # Required. The resource for which the policy is being specified. This policy |
| 150 | # replaces any existing policy. |
| 151 | "policy": { # Defines an access control policy to the resources. # Required. The policy to be applied to the `resource`. |
| 152 | "etag": "A String", # The [etag] is used for optimistic concurrency control as a way to |
| 153 | # help prevent simultaneous updates of a policy from overwriting |
| 154 | # each other. It is strongly suggested that systems make use of |
| 155 | # the [etag] in the read-modify-write cycle to perform policy |
| 156 | # updates in order to avoid race conditions: An [etag] is returned |
| 157 | # in the response to [GetPolicy], and systems are expected to put |
| 158 | # that etag in the request to [SetPolicy] to ensure that their |
| 159 | # change will be applied to the same version of the policy. |
| 160 | # |
| 161 | # If no [etag] is provided in the call to [SetPolicy], then the |
| 162 | # existing policy is overwritten blindly. |
| 163 | "assignments": [ |
| 164 | { # Associates `members` with a `role`. |
| 165 | "members": [ # The identities the role is assigned to. It can have the following |
| 166 | # values: |
| 167 | # |
| 168 | # * `{user_email}`: An email address that represents a specific |
| 169 | # Google account. For example: `alice@gmail.com`. |
| 170 | # |
| 171 | # * `{group_email}`: An email address that represents a Google |
| 172 | # group. For example, `viewers@gmail.com`. |
| 173 | "A String", |
| 174 | ], |
| 175 | "role": "A String", # Required. Role that is assigned to `members`. |
| 176 | }, |
| 177 | ], |
| 178 | }, |
| 179 | } |
| 180 | |
| 181 | x__xgafv: string, V1 error format. |
| 182 | Allowed values |
| 183 | 1 - v1 error format |
| 184 | 2 - v2 error format |
| 185 | |
| 186 | Returns: |
| 187 | An object of the form: |
| 188 | |
| 189 | { # Defines an access control policy to the resources. |
| 190 | "etag": "A String", # The [etag] is used for optimistic concurrency control as a way to |
| 191 | # help prevent simultaneous updates of a policy from overwriting |
| 192 | # each other. It is strongly suggested that systems make use of |
| 193 | # the [etag] in the read-modify-write cycle to perform policy |
| 194 | # updates in order to avoid race conditions: An [etag] is returned |
| 195 | # in the response to [GetPolicy], and systems are expected to put |
| 196 | # that etag in the request to [SetPolicy] to ensure that their |
| 197 | # change will be applied to the same version of the policy. |
| 198 | # |
| 199 | # If no [etag] is provided in the call to [SetPolicy], then the |
| 200 | # existing policy is overwritten blindly. |
| 201 | "assignments": [ |
| 202 | { # Associates `members` with a `role`. |
| 203 | "members": [ # The identities the role is assigned to. It can have the following |
| 204 | # values: |
| 205 | # |
| 206 | # * `{user_email}`: An email address that represents a specific |
| 207 | # Google account. For example: `alice@gmail.com`. |
| 208 | # |
| 209 | # * `{group_email}`: An email address that represents a Google |
| 210 | # group. For example, `viewers@gmail.com`. |
| 211 | "A String", |
| 212 | ], |
| 213 | "role": "A String", # Required. Role that is assigned to `members`. |
| 214 | }, |
| 215 | ], |
| 216 | }</pre> |
| 217 | </div> |
| 218 | |
| 219 | <div class="method"> |
| 220 | <code class="details" id="test">test(body=None, x__xgafv=None)</code> |
| 221 | <pre>Returns permissions that a caller has on the specified resource. |
| 222 | |
| 223 | Args: |
| 224 | body: object, The request body. |
| 225 | The object takes the form of: |
| 226 | |
| 227 | { # Request message for `TestPermissions` method. |
| 228 | "resource": "A String", # Required. The resource for which the permissions are being requested. |
| 229 | "permissions": [ # The set of permissions to check for the `resource`. |
| 230 | "A String", |
| 231 | ], |
| 232 | } |
| 233 | |
| 234 | x__xgafv: string, V1 error format. |
| 235 | Allowed values |
| 236 | 1 - v1 error format |
| 237 | 2 - v2 error format |
| 238 | |
| 239 | Returns: |
| 240 | An object of the form: |
| 241 | |
| 242 | { # Response message for `TestPermissions` method. |
| 243 | "permissions": [ # A set of permissions that the caller is allowed. |
| 244 | "A String", |
| 245 | ], |
| 246 | }</pre> |
| 247 | </div> |
| 248 | |
| 249 | </body></html> |