contact_methods

Creates, updates, deletes, gets or lists a contact_methods resource.

Overview

Name	contact_methods
Type	Resource
Id	pagerduty.users.contact_methods

Fields

The following fields are returned by SELECT queries:

get_user_contact_method

The user's contact method requested.

Name	Datatype	Description

get_user_contact_methods

A list of contact methods.

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_user_contact_method	select	id, contact_method_id	Accept, Content-Type	Get details about a User's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users:contact_methods.read
get_user_contact_methods	select	id	Accept, Content-Type	List contact methods of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users:contact_methods.read
create_user_contact_method	insert	id, data__contact_method	Accept, Content-Type	Create a new contact method for the User. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users:contact_methods.write
delete_user_contact_method	delete	id, contact_method_id	Accept, Content-Type	Remove a user's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users:contact_methods.write
_get_user_contact_methods	exec	id	Accept, Content-Type	List contact methods of your PagerDuty user. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users:contact_methods.read
_get_user_contact_method	exec	id, contact_method_id	Accept, Content-Type	Get details about a User's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users:contact_methods.read
update_user_contact_method	exec	id, contact_method_id, contact_method	Accept, Content-Type	Update a User's contact method. Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account. For more information see the API Concepts Document Scoped OAuth requires: users:contact_methods.write

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
contact_method_id	string	The contact method ID on the user.
id	string	The ID of the resource.
Accept	string	The Accept header is used as a versioning header.
Content-Type	string

SELECT examples

get_user_contact_method

Get details about a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users:contact_methods.read

SELECT
*
FROM pagerduty.users.contact_methods
WHERE id = '{{ id }}' -- required
AND contact_method_id = '{{ contact_method_id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

get_user_contact_methods

List contact methods of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users:contact_methods.read

SELECT
*
FROM pagerduty.users.contact_methods
WHERE id = '{{ id }}' -- required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

INSERT examples

create_user_contact_method

Create a new contact method for the User.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users:contact_methods.write

INSERT INTO pagerduty.users.contact_methods (
data__contact_method,
id,
Accept,
Content-Type
)
SELECT 
'{{ contact_method }}' /* required */,
'{{ id }}',
'{{ Accept }}',
'{{ Content-Type }}'
RETURNING
contact_method
;

Manifest

# Description fields are for documentation purposes
- name: contact_methods
  props:
    - name: id
      value: string
      description: Required parameter for the contact_methods resource.
    - name: contact_method
      value: string
    - name: Accept
      value: string
      description: The `Accept` header is used as a versioning header.
    - name: Content-Type
      value: string

DELETE examples

delete_user_contact_method

Remove a user's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users:contact_methods.write

DELETE FROM pagerduty.users.contact_methods
WHERE id = '{{ id }}' --required
AND contact_method_id = '{{ contact_method_id }}' --required
AND Accept = '{{ Accept }}'
AND Content-Type = '{{ Content-Type }}'
;

Lifecycle Methods

_get_user_contact_methods

List contact methods of your PagerDuty user.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users:contact_methods.read

EXEC pagerduty.users.contact_methods._get_user_contact_methods 
@id='{{ id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

_get_user_contact_method

Get details about a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users:contact_methods.read

EXEC pagerduty.users.contact_methods._get_user_contact_method 
@id='{{ id }}' --required, 
@contact_method_id='{{ contact_method_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}'
;

update_user_contact_method

Update a User's contact method.

Users are members of a PagerDuty account that have the ability to interact with Incidents and other data on the account.

For more information see the API Concepts Document

Scoped OAuth requires: users:contact_methods.write

EXEC pagerduty.users.contact_methods.update_user_contact_method 
@id='{{ id }}' --required, 
@contact_method_id='{{ contact_method_id }}' --required, 
@Accept='{{ Accept }}', 
@Content-Type='{{ Content-Type }}' 
@@json=
'{
"contact_method": "{{ contact_method }}"
}'
;