Delegated RA

Cancel credential by credential name

Use this API to cancel the credential in-case credential was created with wrong organization data.<br> This API can be called only if status of credential is 'pending_issuance' state.

put/api/v2/credential/{name}/cancel

Request

Base URL
https://one.digicert.com/documentmanager
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/digicert/apis/digicert-content-trust-manager/docs/api/v2/credential/:name/cancel/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Credential Name

Query parameters

user_idstring

Request body

notesstring required

Cancellation notes

Example request

{
  "notes": "cancellation notes"
}

Response

created_bystring

modified_onstring date-time

modified_bystring

created_onstring date-time

idstring

Identifier

namestring

Credential Name

user_idstring

DTM user id

account_idstring

DigiCert One Account ID

profile_idstring

Credential Profile ID

first_credentialboolean

This field identify if the credential is a first credential

statusstring

Credential Status (ACTIVE, PENDING_ISSUANCE, DEACTIVATED, REVOKED, SUSPENDED)

cc_order_idstring

Cert central order id

Example response

{
  "id": "69f3fea8-a13f-4359-aacd-d03ee3133671",
  "name": "tets4",
  "user_id": "a37322f1-5fd3-40d1-a1bc-a8640466a052",
  "account_id": "d02b6af4-6497-4d12-9b28-ac0678dd3eef",
  "status": "ACTIVE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.