Manage Essential Contacts

Console

1. In the Google Cloud console, go to the Essential Contacts page.

   Go to the Essential Contacts page

2. Make sure the name of your project, folder, or organization appears in the resource selector of the page. The resource selector lets you select the project, folder, or organization from which you want to view Essential Contacts.

3. Next to View by, you can choose one of the following options:

   • To view the list of contacts by category, select Category.
   • To view the list of contacts alphabetically, select Contact.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. With the Google Cloud CLI, you can either list the contacts that are defined on a resource or list all contacts and inherited contacts for a resource.

   List contacts defined on a resource

   To view Essential Contacts defined on a specific project, folder, or organization, use the gcloud essential-contacts list command:

   gcloud essential-contacts list --RESOURCE_TYPE="RESOURCE_ID"

   Replace the following:

   • RESOURCE_TYPE: the resource type that you want to list contacts from. Use the value project, folder, or organization.
   • RESOURCE_ID: your Google Cloud project number, organization ID, or folder ID. Project numbers, folder IDs, and organization IDs are numeric, like 123456789012. For projects, you must use the numeric project number. Alphanumeric project IDs are not supported.

   Alternatively, if you don't specify a resource type or ID, the gcloud CLI lists contacts from the current project.

   The response is similar to the following example:

   ---
   email: my-contact-1@example.com
   languageTag: en-US
   name: projects/my-projects/contacts/1
   notificationCategorySubscriptions:
   - ALL
   ---
   email: my-contact-2@example.com
   languageTag: en-US
   name: projects/my-projects/contacts/2
   notificationCategorySubscriptions:
   - BILLING
   ---
   

   List contacts and inherited contacts

   If you want to list all contacts from a resource and its inherited contacts from an ancestor, you must have a role on the ancestor resource that includes the required permissions to view contacts. Then, use the gcloud essential-contacts compute command:

   gcloud essential-contacts compute --notification-categories="NOTIFICATION_CATEGORY" \
     --RESOURCE_TYPE="RESOURCE_ID"

   Replace the following:

   • NOTIFICATION_CATEGORY: a comma-separated list of the notification categories that you want to view contacts for. The list can contain any of the following values:

     • billing
     • legal
     • product-updates
     • security
     • suspension
     • technical
     • all
     • notification-category-unspecified

     For more information, see Notification categories.

   • RESOURCE_TYPE: the resource type that you want to view contacts from. Use the value project, folder, or organization.

   • RESOURCE_ID: your Google Cloud project number, organization ID, or folder ID. Project numbers, folder IDs, and organization IDs are numeric, like 123456789012. For projects, you must use the numeric project number. Alphanumeric project IDs are not supported.

   If you don't specify a resource type and ID, the gcloud CLI lists contacts for the current project.

   The response is similar to the following example:

   ---
   email: my-contact-1@example.com
   languageTag: en-US
   name: projects/my-projects/contacts/1
   notificationCategorySubscriptions:
   - ALL
   ---
   email: my-contact-2@example.com
   languageTag: en-US
   name: projects/my-projects/contacts/2
   notificationCategorySubscriptions:
   - BILLING
   ---
   email: my-organization-contact@example.com
   languageTag: en-US
   name: organizations/my-organization/contacts/1
   notificationCategorySubscriptions:
   - ALL
   ---
   

REST

With the Essential Contacts REST API, you can either list the contacts that are defined on a resource or list all contacts and inherited contacts for a resource.

GET essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts?pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts?pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN
  

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method GET `
  -Headers $headers `
  -Uri "https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts?pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN" | Select-Object -Expand Content
  

{
  "contacts": [
    {
      "name": "projects/my-projects/contacts/1",
      "email": "my-contact-1@example.com",
      "notificationCategorySubscriptions": [
        "ALL"
      ],
      "languageTag": "en-US"
    },
    {
      "name": "projects/my-projects/contacts/2",
      "email": "my-contact-2@example.com",
      "notificationCategorySubscriptions": [
        "BILLING"
      ],
      "languageTag": "en-US"
    }
  ]
}

GET essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts:compute?notificationCategories=NOTIFICATION_CATEGORY&pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts:compute?notificationCategories=NOTIFICATION_CATEGORY&pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method GET `
  -Headers $headers `
  -Uri "https://essentialcontacts.googleapis.com/v1/RESOURCE_TYPE/RESOURCE_ID/contacts:compute?notificationCategories=NOTIFICATION_CATEGORY&pageSize=PAGE_SIZE&pageToken=NEXT_PAGE_TOKEN" | Select-Object -Expand Content

{
  "contacts": [
    {
      "name": "projects/my-projects/contacts/1",
      "email": "my-project-contact-1@example.com",
      "notificationCategorySubscriptions": [
        "ALL"
      ],
      "languageTag": "en-US"
    },
    {
      "name": "projects/my-projects/contacts/2",
      "email": "my-project-contact-2@example.com",
      "notificationCategorySubscriptions": [
        "BILLING"
      ],
      "languageTag": "en-US"
    },
    {
      "name": "organizations/my-organization/contacts/1",
      "email": "my-organization-contact@example.com",
      "notificationCategorySubscriptions": [
        "ALL"
      ],
      "languageTag": "en-US"
    }
  ]
}

Console

1. In the Google Cloud console, go to the Essential Contacts page.

   Go to the Essential Contacts page

2. Make sure the name of your project, folder, or organization appears in the resource selector of the page. The resource selector lets you select the project, folder, or organization from which you want to add Essential Contacts.

3. Click person_add Add contact.

   

4. In the Email and Confirm email fields, enter the email address of the contact you want to add.

5. From the Notification categories drop-down menu, select the categories that you want the contact to receive notifications for.

   For a list of notification categories and recommended contacts, see Notification categories.

6. Click Save.

gcloud

1. In the Google Cloud console, activate Cloud Shell.

   Activate Cloud Shell

   At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

2. Add a new contact with the gcloud essential-contacts create command:

   gcloud essential-contacts