Announcement: All noncommercial projects registered to use Earth Engine before
April 15, 2025 must
verify noncommercial eligibility to maintain Earth Engine access.
GetIamPolicyRequest
Stay organized with collections
Save and categorize content based on your preferences.
Request message for GetIamPolicy method.
| JSON representation |
{
"resource": string,
"options": {
object (GetPolicyOptions)
}
} |
| Fields |
resource |
string
REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
|
options |
object (GetPolicyOptions)
OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
|
GetPolicyOptions
Encapsulates settings provided to GetIamPolicy.
| JSON representation |
{
"requestedPolicyVersion": integer
} |
| Fields |
requestedPolicyVersion |
integer
Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-06 UTC.
[null,null,["Last updated 2025-03-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGetIamPolicy\u003c/code\u003e request retrieves the IAM policy for a specified Google Earth Engine resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the \u003ccode\u003eresource\u003c/code\u003e for which the policy is being requested.\u003c/p\u003e\n"],["\u003cp\u003eOptionally, \u003ccode\u003eGetPolicyOptions\u003c/code\u003e can be included to specify the desired policy version (0, 1, or 3).\u003c/p\u003e\n"],["\u003cp\u003ePolicies with conditional role bindings must use version 3, while others may use any valid version or leave it unset.\u003c/p\u003e\n"],["\u003cp\u003eThe response might contain a lower policy version than requested if the resource doesn't support the specified version.\u003c/p\u003e\n"]]],[],null,["# GetIamPolicyRequest\n\nRequest message for `GetIamPolicy` method.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"resource\": string, \"options\": { object (/earth-engine/reference/rest/Shared.Types/GetIamPolicyRequest#GetPolicyOptions) } } ``` |\n\n| Fields ||\n|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `resource` | `string` REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. |\n| `options` | `object (`[GetPolicyOptions](/earth-engine/reference/rest/Shared.Types/GetIamPolicyRequest#GetPolicyOptions)`)` OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. |\n\nGetPolicyOptions\n----------------\n\nEncapsulates settings provided to GetIamPolicy.\n\n| JSON representation |\n|-----------------------------------------------|\n| ``` { \"requestedPolicyVersion\": integer } ``` |\n\n| Fields ||\n|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestedPolicyVersion` | `integer` Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |"]]