Method: policies.list

List Policies

HTTP request

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

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of results to return. The service may return fewer than this value. If omitted (or set to zero), the server will default to 50. The maximum allowed value is 100, though requests with pageSize greater than that will be capped at 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 values used in the request whose response provided this page token.
filter

string

Optional. A CEL expression for filtering the results.

Policies can be filtered by application with this expression: setting.type.matches('gmail.*'). Policies can be filtered by setting type with this expression: setting.type.matches('*.service_status'). A maximum of one of the above setting.type clauses can be used.

Policies can be filtered by customer with this expression: 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 the customer is omitted, it defaults to customers/my_customer. A maximum of one customer clause can be used.

The && operator can be used to combine one clause on setting.type and one clause on customer as follows: setting.type.matches('gmail.*') && customer == 'customers/my_customer'

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)

A list of policies
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 Authentication Overview.