GetIamPolicyRequest

  • The GetIamPolicy method request message includes a required resource field and an optional options field.

  • The options field is a GetPolicyOptions object, which can contain an optional requestedPolicyVersion integer field.

  • The requestedPolicyVersion field in GetPolicyOptions allows specifying the desired policy version, with valid values 0, 1, and 3.

  • Policies with conditional role bindings require requestedPolicyVersion 3, while policies without them can use any valid value or leave the field unset.

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.