Revoke a credential
GENERATED — DO NOT EDIT DIRECTLY. Produced from the canonical OpenAPI specification by
developer-docs/tools/generate-reference.mjs. Edits are overwritten on the next run.
POST
/v1.0/credentials/{credentialId}/revokeScope: credentials.revoke. Revocation is not reversible and takes effect in the credential's status mechanism immediately. Authenticate with Authorization: ApiKey {key}. Every response carries x-ms-request-id, X-Correlation-Id and X-Request-Id; quote the request id in any support request.
| Operation ID | Credentials_Revoke |
| Plane | Product |
| Versioning | In the path |
| Authentication | Authorization: ApiKey {key} |
| Required scope | credentials.revoke |
| Concurrency | Not applicable |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
credentialId |
string |
Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-ms-client-request-id |
string |
No | Optional caller-supplied correlation value, echoed back on the response and recorded in diagnostics. It never influences authentication, tenant or environment selection, resource lookup or idempotency. |
Request body
Responses
| Status | Body | Meaning |
|---|---|---|
200 |
ApiEnvelopeOfCredentialStatusResponse |
Success. |
400 |
ErrorEnvelope |
The request was not valid. See error model. |
401 |
ErrorEnvelope |
Authentication failed — the API key is missing, malformed, revoked or expired. |
403 |
ErrorEnvelope |
Authenticated, but the key does not carry the required scope. |
404 |
ErrorEnvelope |
Not visible to this caller. A resource in another tenant or environment reports as not found. |
429 |
ErrorEnvelope |
Throttled. See rate limits. |
Response headers: x-ms-request-id
Example
curl -X POST "https://api.example.diligence.id/v1.0/credentials/YOUR_CREDENTIAL_ID/revoke" \
-H "Authorization: ApiKey YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ }'