Method: folders.contacts.compute

Lists all contacts for the resource that are subscribed to the specified notification categories, including contacts inherited from any parent resources.

HTTP request

GET https://essentialcontacts.googleapis.com/v1alpha1/{parent=folders/*}/contacts:compute

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the resource to compute contacts for. Format: organizations/{organization_id}, folders/{folder_id} or projects/{project_id}

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

  • essentialcontacts.contacts.list

Query parameters

Parameters
notificationCategory

enum (NotificationCategory)

The category of notification to compute contacts for. Deprecated: use repeated notificationCategories field instead

notificationCategories

enum (NotificationCategory)

The categories of notifications to compute contacts for. If ALL is included in this list, contacts subscribed to any notification category will be returned.

pageSize

integer

Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. If not specified, the default pageSize is 100.

pageToken

string

Optional. If present, retrieves the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.

includeUnverifiedContacts

boolean

By default unverified contacts are filtered out from computeContacts response

includeIamContacts

boolean

By default, IAM contacts are only returned when no essential contacts have been set on a resource. When this flag is true, IAM lookup will be performed regardless of whether there are also contacts set.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ComputeContactsResponse.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.