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.projects.html">projects</a> . <a href="iam_v1.projects.locations.html">locations</a> . <a href="iam_v1.projects.locations.workloadIdentityPools.html">workloadIdentityPools</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="iam_v1.projects.locations.workloadIdentityPools.operations.html">operations()</a></code> 79</p> 80<p class="firstline">Returns the operations Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="iam_v1.projects.locations.workloadIdentityPools.providers.html">providers()</a></code> 84</p> 85<p class="firstline">Returns the providers Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#create">create(parent, body=None, workloadIdentityPoolId=None, x__xgafv=None)</a></code></p> 92<p class="firstline">Creates a new WorkloadIdentityPool. You cannot reuse the name of a deleted pool until 30 days after deletion.</p> 93<p class="toc_element"> 94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 95<p class="firstline">Deletes a WorkloadIdentityPool. You cannot use a deleted pool to exchange external credentials for Google Cloud credentials. However, deletion does not revoke credentials that have already been issued. Credentials issued for a deleted pool do not grant access to resources. If the pool is undeleted, and the credentials are not expired, they grant access again. You can undelete a pool for 30 days. After 30 days, deletion is permanent. You cannot update deleted pools. However, you can view and list them.</p> 96<p class="toc_element"> 97 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 98<p class="firstline">Gets an individual WorkloadIdentityPool.</p> 99<p class="toc_element"> 100 <code><a href="#list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p> 101<p class="firstline">Lists all non-deleted WorkloadIdentityPools in a project. If `show_deleted` is set to `true`, then deleted pools are also listed.</p> 102<p class="toc_element"> 103 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 104<p class="firstline">Retrieves the next page of results.</p> 105<p class="toc_element"> 106 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 107<p class="firstline">Updates an existing WorkloadIdentityPool.</p> 108<p class="toc_element"> 109 <code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p> 110<p class="firstline">Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago.</p> 111<h3>Method Details</h3> 112<div class="method"> 113 <code class="details" id="close">close()</code> 114 <pre>Close httplib2 connections.</pre> 115</div> 116 117<div class="method"> 118 <code class="details" id="create">create(parent, body=None, workloadIdentityPoolId=None, x__xgafv=None)</code> 119 <pre>Creates a new WorkloadIdentityPool. You cannot reuse the name of a deleted pool until 30 days after deletion. 120 121Args: 122 parent: string, Required. The parent resource to create the pool in. The only supported location is `global`. (required) 123 body: object, The request body. 124 The object takes the form of: 125 126{ # Represents a collection of external workload identities. You can define IAM policies to grant these identities access to Google Cloud resources. 127 "description": "A String", # A description of the pool. Cannot exceed 256 characters. 128 "disabled": True or False, # Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. 129 "displayName": "A String", # A display name for the pool. Cannot exceed 32 characters. 130 "name": "A String", # Output only. The resource name of the pool. 131 "state": "A String", # Output only. The state of the pool. 132} 133 134 workloadIdentityPoolId: string, Required. The ID to use for the pool, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix `gcp-` is reserved for use by Google, and may not be specified. 135 x__xgafv: string, V1 error format. 136 Allowed values 137 1 - v1 error format 138 2 - v2 error format 139 140Returns: 141 An object of the form: 142 143 { # This resource represents a long-running operation that is the result of a network API call. 144 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 145 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 146 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 147 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 148 { 149 "a_key": "", # Properties of the object. Contains field @type with type URL. 150 }, 151 ], 152 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 153 }, 154 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 155 "a_key": "", # Properties of the object. Contains field @type with type URL. 156 }, 157 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 158 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 159 "a_key": "", # Properties of the object. Contains field @type with type URL. 160 }, 161}</pre> 162</div> 163 164<div class="method"> 165 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 166 <pre>Deletes a WorkloadIdentityPool. You cannot use a deleted pool to exchange external credentials for Google Cloud credentials. However, deletion does not revoke credentials that have already been issued. Credentials issued for a deleted pool do not grant access to resources. If the pool is undeleted, and the credentials are not expired, they grant access again. You can undelete a pool for 30 days. After 30 days, deletion is permanent. You cannot update deleted pools. However, you can view and list them. 167 168Args: 169 name: string, Required. The name of the pool to delete. (required) 170 x__xgafv: string, V1 error format. 171 Allowed values 172 1 - v1 error format 173 2 - v2 error format 174 175Returns: 176 An object of the form: 177 178 { # This resource represents a long-running operation that is the result of a network API call. 179 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 180 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 181 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 182 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 183 { 184 "a_key": "", # Properties of the object. Contains field @type with type URL. 185 }, 186 ], 187 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 188 }, 189 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 190 "a_key": "", # Properties of the object. Contains field @type with type URL. 191 }, 192 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 193 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 194 "a_key": "", # Properties of the object. Contains field @type with type URL. 195 }, 196}</pre> 197</div> 198 199<div class="method"> 200 <code class="details" id="get">get(name, x__xgafv=None)</code> 201 <pre>Gets an individual WorkloadIdentityPool. 202 203Args: 204 name: string, Required. The name of the pool to retrieve. (required) 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # Represents a collection of external workload identities. You can define IAM policies to grant these identities access to Google Cloud resources. 214 "description": "A String", # A description of the pool. Cannot exceed 256 characters. 215 "disabled": True or False, # Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. 216 "displayName": "A String", # A display name for the pool. Cannot exceed 32 characters. 217 "name": "A String", # Output only. The resource name of the pool. 218 "state": "A String", # Output only. The state of the pool. 219}</pre> 220</div> 221 222<div class="method"> 223 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code> 224 <pre>Lists all non-deleted WorkloadIdentityPools in a project. If `show_deleted` is set to `true`, then deleted pools are also listed. 225 226Args: 227 parent: string, Required. The parent resource to list pools for. (required) 228 pageSize: integer, The maximum number of pools to return. If unspecified, at most 50 pools are returned. The maximum value is 1000; values above are 1000 truncated to 1000. 229 pageToken: string, A page token, received from a previous `ListWorkloadIdentityPools` call. Provide this to retrieve the subsequent page. 230 showDeleted: boolean, Whether to return soft-deleted pools. 231 x__xgafv: string, V1 error format. 232 Allowed values 233 1 - v1 error format 234 2 - v2 error format 235 236Returns: 237 An object of the form: 238 239 { # Response message for ListWorkloadIdentityPools. 240 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 241 "workloadIdentityPools": [ # A list of pools. 242 { # Represents a collection of external workload identities. You can define IAM policies to grant these identities access to Google Cloud resources. 243 "description": "A String", # A description of the pool. Cannot exceed 256 characters. 244 "disabled": True or False, # Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. 245 "displayName": "A String", # A display name for the pool. Cannot exceed 32 characters. 246 "name": "A String", # Output only. The resource name of the pool. 247 "state": "A String", # Output only. The state of the pool. 248 }, 249 ], 250}</pre> 251</div> 252 253<div class="method"> 254 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 255 <pre>Retrieves the next page of results. 256 257Args: 258 previous_request: The request for the previous page. (required) 259 previous_response: The response from the request for the previous page. (required) 260 261Returns: 262 A request object that you can call 'execute()' on to request the next 263 page. Returns None if there are no more items in the collection. 264 </pre> 265</div> 266 267<div class="method"> 268 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 269 <pre>Updates an existing WorkloadIdentityPool. 270 271Args: 272 name: string, Output only. The resource name of the pool. (required) 273 body: object, The request body. 274 The object takes the form of: 275 276{ # Represents a collection of external workload identities. You can define IAM policies to grant these identities access to Google Cloud resources. 277 "description": "A String", # A description of the pool. Cannot exceed 256 characters. 278 "disabled": True or False, # Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. 279 "displayName": "A String", # A display name for the pool. Cannot exceed 32 characters. 280 "name": "A String", # Output only. The resource name of the pool. 281 "state": "A String", # Output only. The state of the pool. 282} 283 284 updateMask: string, Required. The list of fields to update. 285 x__xgafv: string, V1 error format. 286 Allowed values 287 1 - v1 error format 288 2 - v2 error format 289 290Returns: 291 An object of the form: 292 293 { # This resource represents a long-running operation that is the result of a network API call. 294 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 295 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 296 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 297 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 298 { 299 "a_key": "", # Properties of the object. Contains field @type with type URL. 300 }, 301 ], 302 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 303 }, 304 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 305 "a_key": "", # Properties of the object. Contains field @type with type URL. 306 }, 307 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 308 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 309 "a_key": "", # Properties of the object. Contains field @type with type URL. 310 }, 311}</pre> 312</div> 313 314<div class="method"> 315 <code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code> 316 <pre>Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago. 317 318Args: 319 name: string, Required. The name of the pool to undelete. (required) 320 body: object, The request body. 321 The object takes the form of: 322 323{ # Request message for UndeleteWorkloadIdentityPool. 324} 325 326 x__xgafv: string, V1 error format. 327 Allowed values 328 1 - v1 error format 329 2 - v2 error format 330 331Returns: 332 An object of the form: 333 334 { # This resource represents a long-running operation that is the result of a network API call. 335 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 336 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 337 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 338 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 339 { 340 "a_key": "", # Properties of the object. Contains field @type with type URL. 341 }, 342 ], 343 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 344 }, 345 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 346 "a_key": "", # Properties of the object. Contains field @type with type URL. 347 }, 348 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 349 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 350 "a_key": "", # Properties of the object. Contains field @type with type URL. 351 }, 352}</pre> 353</div> 354 355</body></html>