Method: organizations.customConstraints.list

Retrieves all of the custom constraints that exist on a particular organization resource.

HTTP request

GET https://orgpolicy.googleapis.com/v2/{parent=organizations/*}/customConstraints

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The target Google Cloud resource that parents the set of custom constraints that will be returned from this call. Must be in one of the following forms:

  • organizations/{organization_id}

Authorization requires the following IAM permission on the specified resource parent:

  • orgpolicy.customConstraints.list

Query parameters

Parameters
pageSize

integer

Size of the pages to be returned. This is currently unsupported and will be ignored. The server may at any point start using this field to limit page size.
pageToken

string

Page token used to retrieve the next page. This is currently unsupported and will be ignored. The server may at any point start using this field.

Request body

The request body must be empty.

Response body

The response returned from the customConstraints.list method. It will be empty if no custom constraints are set on the organization resource.

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

JSON representation 
{
  "customConstraints": [
    {
      object (CustomConstraint)
    }
  ],
  "nextPageToken": string
}
Fields
customConstraints[]

object (CustomConstraint)

All custom constraints that exist on the organization resource. It will be empty if no custom constraints are set.
nextPageToken

string

Page token used to retrieve the next page. This is currently not used, but the server may at any point start supplying a valid token.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.