webhook_oauth2_client_credentials

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

Overview

Name	webhook_oauth2_client_credentials
Type	Resource
Id	datadog.integrations.webhook_oauth2_client_credentials

Fields

The following fields are returned by SELECT queries:

get_oauth2_client_credentials

Name	Datatype	Description
id	string	The ID of the OAuth2 client credentials auth method. (example: 596da4af-0563-4097-90ff-07230c3f9db3)
attributes	object	OAuth2 client credentials attributes returned by the API. The client_secret is never echoed.
type	string	OAuth2 client credentials resource type. (webhooks-auth-method-oauth2-client-credentials) (default: webhooks-auth-method-oauth2-client-credentials, example: webhooks-auth-method-oauth2-client-credentials)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_oauth2_client_credentials	select	auth_method_id		Get a single OAuth2 client credentials auth method by ID.
create_oauth2_client_credentials	insert	data		Create a new OAuth2 client credentials auth method for the Webhooks<br />integration. The client_secret is stored securely and never returned.
update_oauth2_client_credentials	update	auth_method_id, data		Update an existing OAuth2 client credentials auth method.
delete_oauth2_client_credentials	delete	auth_method_id		Delete an OAuth2 client credentials auth method by ID.

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
auth_method_id	string	The UUID of the auth method.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.

SELECT examples

get_oauth2_client_credentials

Get a single OAuth2 client credentials auth method by ID.

SELECT
id,
attributes,
type
FROM datadog.integrations.webhook_oauth2_client_credentials
WHERE auth_method_id = '{{ auth_method_id }}' -- required
;

INSERT examples

create_oauth2_client_credentials

Create a new OAuth2 client credentials auth method for the Webhooks<br />integration. The client_secret is stored securely and never returned.

INSERT INTO datadog.integrations.webhook_oauth2_client_credentials (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: webhook_oauth2_client_credentials
props:
  - name: data
    description: |
      OAuth2 client credentials data for a create request.
    value:
      attributes:
        access_token_url: "{{ access_token_url }}"
        audience: "{{ audience }}"
        client_id: "{{ client_id }}"
        client_secret: "{{ client_secret }}"
        name: "{{ name }}"
        scope: "{{ scope }}"
      type: "{{ type }}"

UPDATE examples

update_oauth2_client_credentials

Update an existing OAuth2 client credentials auth method.

UPDATE datadog.integrations.webhook_oauth2_client_credentials
SET 
data = '{{ data }}'
WHERE 
auth_method_id = '{{ auth_method_id }}' --required
AND data = '{{ data }}' --required
RETURNING
data;

DELETE examples

delete_oauth2_client_credentials

Delete an OAuth2 client credentials auth method by ID.

DELETE FROM datadog.integrations.webhook_oauth2_client_credentials
WHERE auth_method_id = '{{ auth_method_id }}' --required
;