Method: policies.list

List policies.

HTTP request

GET https://cloudidentity.googleapis.com/v1/policies

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0, the default is 50 results per page. The maximum allowed value is 100. pageSize values greater than 100 default to 100.
pageToken

string

Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to ListPoliciesRequest must match the call that provided the page token.
filter

string

Optional. A CEL expression for filtering the results.

Policies can be filtered using the expression in the following ways:

  • Filter by application: setting.type.matches('^settings/gmail\\..*$')
  • Filter by setting type: setting.type.matches('^.*\\.service_status$')
  • Filter by customer: customer == "customers/{customer}" Where customer is the id from the Admin SDK Customer resource. You may use customers/my_customer to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. You may only filter on policies for a single customer at a time.

The above clauses can be combined together in a single filter expression with the && and || operators, like in the following example: customer == "customers/my_customer" && ( setting.type.matches('^settings/gmail\\..*$') || setting.type.matches('^.*\\.service_status$') ).

Request body

The request body must be empty.

Response body

The response message for PoliciesService.ListPolicies.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "policies": [
    {
      object (Policy)
    }
  ],
  "nextPageToken": string
}
Fields
policies[]

object (Policy)

The results
nextPageToken

string

The pagination token to retrieve the next page of results. If this field is empty, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.policies.readonly
  • https://www.googleapis.com/auth/cloud-identity.policies

For more information, see the Authorization guide.