Policy API overview

The Cloud Identity Policy API lets you programmatically view or modify the settings that administrators configure for a Google Workspace domain in the Google Admin console.

Note: Modifying policies is available only in the v1beta1 API, which supports only a subset of settings. To see whether a setting is supported for mutate endpoints, check the Mutate Supported in v1beta1 column in Policy API supported settings.

The Cloud Identity Policy API provides a different view of policies than the Google Admin console. For a given setting, the Admin console displays a reduced setting value for an organization unit or group, whereas the Cloud Identity Policy API provides the underlying source of truth policies where a value has been explicitly set.

Only a super administrator can use the Cloud Identity Policy API.

What's next

• To set up Cloud Identity, see Setting up Cloud Identity.
• To set up the Policy API, see Setting up the Policy API.
• To list and get policies, see Listing and getting policies.
• To learn more about which settings are readable or modifiable by the Policy API, see Policy API supported settings.