Delete a DID key

DELETE

/api/v1/auth/did-key/{keyId}

const url = 'https://localhost:8080/api/v1/auth/did-key/example';
const options = {method: 'DELETE', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://localhost:8080/api/v1/auth/did-key/example \
  --header 'Authorization: <Authorization>'

Delete one of the authenticated user’s DID keys from the configured key provider. The development OpenBao profile rejects deletion; operators disable signing through policy.

Authorizations

BearerAuth
ApiKeyAuth

Parameters

Path Parameters

keyId

required

string

Provider key ID (e.g., auth0-abc123) or the key’s did:key

Responses

200

Key deleted successfully

application/json

Confirmation body for endpoints that return no resource

object

message

string

Example

{
  "message": "Operation completed successfully"
}

400

Bad request - Key ID required

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - May only access your own DID keys

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

404

DID key not found

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

501

Provider does not support key deletion

application/json

Error body returned across the auth endpoints; the message is human-readable and not a stable identifier

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}