PATCH https://api.ap1.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}https://api.ap2.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}https://api.datadoghq.eu/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}https://api.ddog-gov.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}https://api.us2.ddog-gov.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}https://api.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}https://api.us3.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}https://api.us5.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}
Overview
Update an existing OAuth2 client credentials auth method.
This endpoint requires the manage_integrations permission.
Arguments
Path Parameters
auth_method_id [required]
The UUID of the auth method.
Request
Body Data (required)
OAuth2 client credentials payload.
Expand All
OAuth2 client credentials data for an update request.
OAuth2 client credentials attributes for an update request.
URL of the OAuth2 access token endpoint.
The intended audience for the OAuth2 access token.
The OAuth2 client ID issued by the authorization server.
The OAuth2 client secret issued by the authorization server.
Write-only; never returned by the API.
Human-readable name for this auth method.
Space-separated list of OAuth2 scopes to request.
OAuth2 client credentials resource type.
Allowed enum values: webhooks-auth-method-oauth2-client-credentials
default: webhooks-auth-method-oauth2-client-credentials
{
"data": {
"attributes": {
"access_token_url": "https://example.com/oauth/token",
"audience": "https://api.example.com",
"client_id": "my-client-id",
"client_secret": "my-client-secret",
"name": "my-oauth2-auth",
"scope": "read:webhooks write:webhooks"
},
"type": "webhooks-auth-method-oauth2-client-credentials"
}
}
Response
OK
Response containing an OAuth2 client credentials auth method.
Expand All
OAuth2 client credentials data from a response.
OAuth2 client credentials attributes returned by the API. The client_secret is never echoed.
URL of the OAuth2 access token endpoint.
The intended audience for the OAuth2 access token.
The OAuth2 client ID issued by the authorization server.
Human-readable name for this auth method.
Authentication protocol used by the auth method.
Allowed enum values: oauth2-client-credentials
Space-separated list of OAuth2 scopes to request.
The ID of the OAuth2 client credentials auth method.
OAuth2 client credentials resource type.
Allowed enum values: webhooks-auth-method-oauth2-client-credentials
default: webhooks-auth-method-oauth2-client-credentials
{
"data": {
"attributes": {
"access_token_url": "https://example.com/oauth/token",
"audience": "https://api.example.com",
"client_id": "my-client-id",
"name": "my-oauth2-auth",
"protocol": "oauth2-client-credentials",
"scope": "read:webhooks write:webhooks"
},
"id": "596da4af-0563-4097-90ff-07230c3f9db3",
"type": "webhooks-auth-method-oauth2-client-credentials"
}
}
Bad Request
{
"errors": [
"Bad Request"
]
}
Forbidden
{
"errors": [
"Bad Request"
]
}
Not Found
{
"errors": [
"Bad Request"
]
}
Conflict
{
"errors": [
"Bad Request"
]
}
Too many requests
{
"errors": [
"Bad Request"
]
}
Code Example
## default
#
# Path parameters
export auth_method_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/${auth_method_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"name": "my-oauth2-auth-renamed"
},
"type": "webhooks-auth-method-oauth2-client-credentials"
}
}
EOF
