OPTIONAL: AGetPolicyOptionsobject for specifying options toGetIamPolicy.
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 theIAM documentation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-17 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eGetIamPolicy\u003c/code\u003e method's request requires a \u003ccode\u003eresource\u003c/code\u003e string, representing the resource for which the policy is requested.\u003c/p\u003e\n"],["\u003cp\u003eAn optional \u003ccode\u003eoptions\u003c/code\u003e object, specifically a \u003ccode\u003eGetPolicyOptions\u003c/code\u003e instance, can be included in the \u003ccode\u003eGetIamPolicy\u003c/code\u003e request to specify retrieval options.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetPolicyOptions\u003c/code\u003e uses \u003ccode\u003erequestedPolicyVersion\u003c/code\u003e to define the maximum policy version for the format, with valid values being 0, 1, or 3.\u003c/p\u003e\n"],["\u003cp\u003eSpecifying a \u003ccode\u003erequestedPolicyVersion\u003c/code\u003e of 3 is mandatory if requesting policies with any conditional role bindings.\u003c/p\u003e\n"],["\u003cp\u003eResources that support conditional role binding can be found in the IAM documentation.\u003c/p\u003e\n"]]],[],null,["# GetIamPolicyRequest\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [GetPolicyOptions](#GetPolicyOptions)\n - [JSON representation](#GetPolicyOptions.SCHEMA_REPRESENTATION)\n\nRequest message for `GetIamPolicy` method.\n\nGetPolicyOptions\n----------------\n\nEncapsulates settings provided to GetIamPolicy."]]
