Organization Policy API

The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy.

Service: orgpolicy.googleapis.com

To call this service, we recommend that you use the Google-providedclient libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

ADiscovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

Aservice endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://orgpolicy.googleapis.com

REST Resource:v2.folders.constraints

Methods
listGET /v2/{parent=folders/*}/constraints
Lists constraints that could be applied on the specified resource.

REST Resource:v2.folders.policies

Methods
createPOST /v2/{parent=folders/*}/policies
Creates a policy.
deleteDELETE /v2/{name=folders/*/policies/*}
Deletes a policy.
getGET /v2/{name=folders/*/policies/*}
Gets a policy on a resource.
getEffectivePolicyGET /v2/{name=folders/*/policies/*}:getEffectivePolicy
Gets the effective policy on a resource.
listGET /v2/{parent=folders/*}/policies
Retrieves all of the policies that exist on a particular resource.
patchPATCH /v2/{policy.name=folders/*/policies/*}
Updates a policy.

REST Resource:v2.organizations.constraints

Methods
listGET /v2/{parent=organizations/*}/constraints
Lists constraints that could be applied on the specified resource.

REST Resource:v2.organizations.customConstraints

Methods
createPOST /v2/{parent=organizations/*}/customConstraints
Creates a custom constraint.
deleteDELETE /v2/{name=organizations/*/customConstraints/*}
Deletes a custom constraint.
getGET /v2/{name=organizations/*/customConstraints/*}
Gets a custom or managed constraint.
listGET /v2/{parent=organizations/*}/customConstraints
Retrieves all of the custom constraints that exist on a particular organization resource.
patchPATCH /v2/{customConstraint.name=organizations/*/customConstraints/*}
Updates a custom constraint.

REST Resource:v2.organizations.policies

Methods
createPOST /v2/{parent=organizations/*}/policies
Creates a policy.
deleteDELETE /v2/{name=organizations/*/policies/*}
Deletes a policy.
getGET /v2/{name=organizations/*/policies/*}
Gets a policy on a resource.
getEffectivePolicyGET /v2/{name=organizations/*/policies/*}:getEffectivePolicy
Gets the effective policy on a resource.
listGET /v2/{parent=organizations/*}/policies
Retrieves all of the policies that exist on a particular resource.
patchPATCH /v2/{policy.name=organizations/*/policies/*}
Updates a policy.

REST Resource:v2.projects.constraints

Methods
listGET /v2/{parent=projects/*}/constraints
Lists constraints that could be applied on the specified resource.

REST Resource:v2.projects.policies

Methods
createPOST /v2/{parent=projects/*}/policies
Creates a policy.
deleteDELETE /v2/{name=projects/*/policies/*}
Deletes a policy.
getGET /v2/{name=projects/*/policies/*}
Gets a policy on a resource.
getEffectivePolicyGET /v2/{name=projects/*/policies/*}:getEffectivePolicy
Gets the effective policy on a resource.
listGET /v2/{parent=projects/*}/policies
Retrieves all of the policies that exist on a particular resource.
patchPATCH /v2/{policy.name=projects/*/policies/*}
Updates a policy.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-14 UTC.