OPTIONAL: AGetPolicyOptionsobject for specifying options topolicy.getIamPolicy.
GetPolicyOptions
Encapsulates settings provided to policy.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-05-30 UTC."],[[["\u003cp\u003eThe \u003ccode\u003epolicy.getIamPolicy\u003c/code\u003e method requires a request message with a \u003ccode\u003eresource\u003c/code\u003e field (a string) and an optional \u003ccode\u003eoptions\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eresource\u003c/code\u003e field in the request message specifies the target resource for which the policy is being requested.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoptions\u003c/code\u003e field, of type \u003ccode\u003eGetPolicyOptions\u003c/code\u003e, allows users to specify options for the \u003ccode\u003epolicy.getIamPolicy\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGetPolicyOptions\u003c/code\u003e contains \u003ccode\u003erequestedPolicyVersion\u003c/code\u003e, an optional integer field to set the desired policy version, with valid values being 0, 1, and 3.\u003c/p\u003e\n"],["\u003cp\u003eSpecifying version 3 is mandatory for policies with conditional role bindings, while other policies may use versions 0 or 1, or leave it unset.\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 `policy.getIamPolicy` method.\n\nGetPolicyOptions\n----------------\n\nEncapsulates settings provided to policy.getIamPolicy."]]
