Revoke the Organization's credential for a Provider

DELETE /v1/provider-credentials/{provider}

Revokes the active version If-Match names (or any, with *) and answers it with status revoked; not_found when the Organization has no active credential for the Provider (1.28.0). The Organization's next Calls run the Provider on the platform's keys. From 1.34.0 the description states what a revocation does to the Calls in progress (workspace ADR 0082, decision 5), where 1.28.0 said that they keep the version they were issued: a revocation ends the Calls that use the key. The sweeper of the api, at its next sweep (every 5 seconds by default, a target), asks the end of each Call in progress whose recorded credential is the revoked version, as POST /v1/calls/{call_id}/end does, with the reason code credential_revoked on the Call event call.end_requested and the Audit event call.end; the worker ends the Session canceled at its next signal (every 15 seconds by default), about 20 seconds in all (a target), and a Call no worker runs yet ends canceled at once. The Audit event provider_credential.revoke is written in the revocation's own transaction and does not wait for the sweep, and a Call claimed between the revocation and the next sweep starts on the withdrawn key and is ended by that sweep. A rotation by PUT replaces the key and does not withdraw it, so a Call in progress stays on the version it was issued. Session only: the api refuses the route to every API key, whatever its scopes, and accepts a Member ID token with credentials:write.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the credentials:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X DELETE "$VOCAL_API/v1/provider-credentials/mock" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"'

const response = await fetch(`${process.env.VOCAL_API}/v1/provider-credentials/mock`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.delete(
    f"{os.environ['VOCAL_API']}/v1/provider-credentials/mock",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is ProviderCredential.