Delete OAuth credentials

Deletes an OAuth credential set. By default the delete is refused while the credentials are still in use: if any webhook references them, nothing is deleted and the request fails with 409 Conflict, naming the reason and listing the ids of the referencing webhooks. This protects a shared credential set from being removed out from under the webhooks that depend on it, since several webhooks may reference the same one.

Pass forceDelete=true to delete anyway. That detaches every referencing webhook — it clears each webhook’s webhookOauthId, it does not delete the webhook — then deletes the credential set and returns the deleted resource together with detachedWebhookIds. The detached webhooks keep delivering notifications, but without an Authorization header, so their endpoints will see unauthenticated deliveries from that point on.

When nothing references the credentials the delete succeeds either way, and detachedWebhookIds comes back empty.

Endpoint Permissions: Owner, Admin, Non-Signing Admin.

DELETE

webhooks_settings

oauth

{webhookOauthId}

TypeScript

const response: Promise<FireblocksResponse<DeleteWebhookOAuthResponse>> = fireblocks.webhooksV2.deleteWebhookOAuth(webhooksV2ApiDeleteWebhookOAuthRequest);

const options = {method: 'DELETE'};

fetch('https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production treasury gateway",
  "clientId": "my-client-id",
  "url": "https://auth.example.com/oauth/token",
  "authMethod": "client_secret_basic",
  "createdAt": 1625097600000,
  "updatedAt": 1625097600000,
  "detachedWebhookIds": [
    "44fcead0-7053-4831-a53a-df7fb90d440f"
  ],
  "customJwtClaims": [
    "aud",
    "resource"
  ],
  "customBodyParams": [
    "scope"
  ],
  "customHeaders": [
    "X-Api-Key"
  ],
  "mtlsClientSignedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Path Parameters

webhookOauthId

string<uuid>

required

The unique identifier of the OAuth credentials

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

Query Parameters

forceDelete

boolean

default:false

Delete the credentials even while webhooks still reference them, detaching those webhooks instead of refusing. Leave it unset, or false, to get a 409 Conflict whenever anything still references the credentials.

Response

The deleted OAuth credentials, plus the ids of any webhooks that were detached from them

The deleted OAuth credential set, plus the ids of any webhooks the delete detached from it. Webhooks are only detached by forceDelete=true; without it a delete is refused with 409 while anything still references the credentials.

string<uuid>

required

The id of the OAuth credentials. Pass this as a webhook's webhookOauthId to attach them.

Example:

"123e4567-e89b-12d3-a456-426614174000"

name

string

required

The label given to this credential set.

Example:

"Production treasury gateway"

clientId

string

required

OAuth client ID used to authenticate with the token endpoint.

Example:

"my-client-id"

url

string

required

Token endpoint URL.

Example:

"https://auth.example.com/oauth/token"

authMethod

string

default:client_secret_basic

required

How the client credentials are presented to the token endpoint: client_secret_basic, client_secret_post or client_secret_jwt. Credentials created without this field report client_secret_basic, which is what they use.

Example:

"client_secret_basic"

createdAt

integer<int64>

required

The date and time the OAuth credentials were created, in milliseconds.

Example:

1625097600000

updatedAt

integer<int64>

required

The date and time the OAuth credentials were last updated, in milliseconds.

Example:

1625097600000

detachedWebhookIds

string<uuid>[]

required

Webhooks whose webhookOauthId was cleared. The webhooks themselves are not deleted and keep delivering, just without an Authorization header. Empty unless forceDelete=true detached something.

Example:

["44fcead0-7053-4831-a53a-df7fb90d440f"]

customJwtClaims

string[]

Names of the additional claims placed in the JWT assertion. Claim values are write-only and are never returned. Absent when no custom claims are configured.

Example:

["aud", "resource"]

customBodyParams

string[]

Names of the additional parameters added to the token request body. Parameter values are write-only and are never returned. Absent when no custom parameters are configured.

Example:

["scope"]

customHeaders

string[]

Names of the additional HTTP headers added to the token request sent to the authorization server — not to the webhook delivery, which has its own separate customHeaders. Header values are write-only and are never returned. Absent when no custom headers are configured.

Example:

["X-Api-Key"]

mtlsClientSignedCert

string

PEM-encoded client certificate used for mTLS when fetching OAuth tokens.

Example:

"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"

TypeScript

const response: Promise<FireblocksResponse<DeleteWebhookOAuthResponse>> = fireblocks.webhooksV2.deleteWebhookOAuth(webhooksV2ApiDeleteWebhookOAuthRequest);

const options = {method: 'DELETE'};

fetch('https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/webhooks_settings/oauth/{webhookOauthId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production treasury gateway",
  "clientId": "my-client-id",
  "url": "https://auth.example.com/oauth/token",
  "authMethod": "client_secret_basic",
  "createdAt": 1625097600000,
  "updatedAt": 1625097600000,
  "detachedWebhookIds": [
    "44fcead0-7053-4831-a53a-df7fb90d440f"
  ],
  "customJwtClaims": [
    "aud",
    "resource"
  ],
  "customBodyParams": [
    "scope"
  ],
  "customHeaders": [
    "X-Api-Key"
  ],
  "mtlsClientSignedCert": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
}

{
  "message": "<string>",
  "code": 123
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Delete OAuth credentials

Path Parameters

Query Parameters

Response