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.
[[["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-16 UTC."],[[["\u003cp\u003eThis content describes the request message structure for the \u003ccode\u003eGetIamPolicy\u003c/code\u003e method, which retrieves the IAM policy for a specified resource.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetIamPolicy\u003c/code\u003e request requires a \u003ccode\u003eresource\u003c/code\u003e field (a string identifying the resource) and can optionally include a \u003ccode\u003eGetPolicyOptions\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eGetPolicyOptions\u003c/code\u003e allows specifying the maximum policy version to be used in formatting the policy, with valid values being 0, 1, and 3.\u003c/p\u003e\n"],["\u003cp\u003eIf requesting policies with conditional role bindings, the \u003ccode\u003erequestedPolicyVersion\u003c/code\u003e must be set to 3.\u003c/p\u003e\n"],["\u003cp\u003eThe server may return a lower policy version than requested if the policy does not require the higher version's features.\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."]]
