Delete credential definition
DELETE/v2/config/digital-wallet/openid/sdjwt/credential-definition/:credentialDefinitionId
Deletes a credential definition and removes its credential configurations from the OID4VCI Credential Issuer Metadata. The issuer also deletes every credential issuance history record of this credential definition. Credentials that the issuer already gave to a holder stay valid; revoke them first if you must withdraw them.
Request
Path Parameters
Unique identifier of the credential definition that specifies the credential format, type, and claims structure for OID4VCI issuance.
Header Parameters
Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.
The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.
X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.
The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.
Responses
- 204
- 400
- 401
- 500
The issuer deleted the credential definition. The response body is empty.
Response Headers
The organisation is unknown, no credential definition matches credentialDefinitionId, or the issuer cannot delete the credential definition.
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}
Internal server error
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
{
"errorCode": 400,
"errorDescription": "Bad input parameter"
}