Skip to content

Revoke project policy credential

PUT
/api/v1/projects/{projectId}/policies/{projectPolicyId}/credentials/{credentialId}/revoke
curl --request PUT \
--url https://localhost:10001/api/v1/projects/1/policies/1/credentials/1/revoke \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "reason": "example" }'

Revoke a specific issued credential associated with a project policy

projectId
required
integer

Project ID

projectPolicyId
required
integer

Project Policy ID

credentialId
required
integer

Credential ID

Revocation reason

Media type application/json
object
reason
string
Example generated
{
"reason": "example"
}

Revoked credential

Media type application/json
object
credential
object
expiresAt
string
id
integer
issuedAt
string
issuedBy
string
projectPolicyId
integer
revoked
boolean
revokedAt
string
revokedBy
string
revokedReason
string
Example generated
{
"credential": {},
"expiresAt": "example",
"id": 1,
"issuedAt": "example",
"issuedBy": "example",
"projectPolicyId": 1,
"revoked": true,
"revokedAt": "example",
"revokedBy": "example",
"revokedReason": "example"
}

Bad request - Invalid IDs, missing reason, or credential already revoked

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Forbidden - No project access or insufficient permissions

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Credential not found

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}

Internal server error

Media type application/json
object
key
additional properties
string
Example generated
{
"additionalProperty": "example"
}