Method: workdeskContacts.list

Full name: projects.locations.instances.legacySoarUsers.workdeskContacts.list

Lists SOAR workdeskContacts.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list WorkdeskContacts for. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarUsers/{legacySoarUser}/workdeskContacts

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of WorkdeskContacts to return. The service may return fewer than this value.
filter

string

Optional. The filter expression.
orderBy

string

Optional. The order in which WorkdeskContacts should be returned.
pageToken

string

Optional. A page token, received from a previous workdeskContacts.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListBooks must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for workdeskContacts.list.

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

JSON representation 
{
  "workdeskContacts": [
    {
      object (WorkdeskContact)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
workdeskContacts[]

object (WorkdeskContact)

The list of WorkdeskContacts.
nextPageToken

string

Optional. A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

Optional. The total number of WorkdeskContacts matching the request.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.