Method: organizations.environments.getIamPolicy

Stay organized with collections Save and categorize content based on your preferences.

Gets the IAM policy on an environment. For more information, see Manage users, roles, and permissions using the API.

You must have the apigee.environments.getIamPolicy permission to call this API.

HTTP request

GET https://apigee.googleapis.com/v1/{resource=organizations/*/environments/*}:getIamPolicy

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resource

string

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Query parameters

Parameters
options

object (GetPolicyOptions)

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Policy.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

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.