REST Resource: projects.locations.instances.legacySoarUsers.workdeskContacts

Resource: WorkdeskContact

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. The WorkdeskContact class represents an individual contact entity within Chronicle SOAR, used for communication and incident management.

JSON representation 
{
  "name": string,
  "contactName": string,
  "phoneNumber": string,
  "email": string,
  "description": string
}
Fields
name

string

Identifier. The resource name of the WorkdeskContact. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarUsers/{legacySoarUser}/workdeskContacts/{workdeskContact}
contactName

string

Required. The contact's name, limited to a maximum of 128 characters.
phoneNumber

string

Required. The contact's phone number, limited to a maximum of 20 characters.
email

string

Required. The contact's email address, limited to a maximum of 254 characters.
description

string

Required. The contact's description, limited to a maximum of 100 characters.

Methods

create

 Creates a new workdesk contact for a specific user.

delete

 Deletes an existing workdesk contact.

get

 Gets a specific workdesk contact.

list

 Lists workdesk contacts for a specific user.

patch

 Updates an existing workdesk contact.