Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

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: 
          
         '
          
         \
        

       

       

        

          
         --header
          
         '
         Content-Type: application/json
         '
          
         \
        

       

       

        

          
         --data
          
         '
         { "reason": "example" }
         '

Revoke a specific issued credential associated with a project policy

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
integer

Project ID

projectPolicyId
required
integer

Project Policy ID

credentialId
required
integer

Credential ID

Request Body

Section titled “Request Body ”

Revocation reason

Media type application/json
object
reason
string
Example generated

          

           

            {
           

          

          

           

             
            "reason"
            : 
            "
            example
            "
           

          

          

           

            }

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Revoked credential

Media type application/json
object
credential
object
credentialId
string
expiresAt
string
id
integer
issuedAt
string
issuedBy
string
projectPolicyId
integer
revoked
boolean
revokedAt
string
revokedBy
string
revokedReason
string
sourceCid
string
Example generated

          

           

            {
           

          

          

           

             
            "credential"
            : {},
           

          

          

           

             
            "credentialId"
            : 
            "
            example
            "
            ,
           

          

          

           

             
            "expiresAt"
            : 
            "
            example
            "
            ,
           

          

          

           

             
            "id"
            : 
            1
            ,
           

          

          

           

             
            "issuedAt"
            : 
            "
            example
            "
            ,
           

          

          

           

             
            "issuedBy"
            : 
            "
            example
            "
            ,
           

          

          

           

             
            "projectPolicyId"
            : 
            1
            ,
           

          

          

           

             
            "revoked"
            : 
            true
            ,
           

          

          

           

             
            "revokedAt"
            : 
            "
            example
            "
            ,
           

          

          

           

             
            "revokedBy"
            : 
            "
            example
            "
            ,
           

          

          

           

             
            "revokedReason"
            : 
            "
            example
            "
            ,
           

          

          

           

             
            "sourceCid"
            : 
            "
            example
            "
           

          

          

           

            }

400

Section titled “400 ”

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

Media type application/json
object
key
additional properties
string
Example generated

          

           

            {
           

          

          

           

             
            "additionalProperty"
            : 
            "
            example
            "
           

          

          

           

            }

401

Section titled “401 ”

Unauthorized - Authentication required

Media type application/json
object
key
additional properties
string
Example generated

          

           

            {
           

          

          

           

             
            "additionalProperty"
            : 
            "
            example
            "
           

          

          

           

            }

403

Section titled “403 ”

Forbidden - No project access or insufficient permissions

Media type application/json
object
key
additional properties
string
Example generated

          

           

            {
           

          

          

           

             
            "additionalProperty"
            : 
            "
            example
            "
           

          

          

           

            }

404

Section titled “404 ”

Credential not found

Media type application/json
object
key
additional properties
string
Example generated

          

           

            {
           

          

          

           

             
            "additionalProperty"
            : 
            "
            example
            "
           

          

          

           

            }

500

Section titled “500 ”

Internal server error

Media type application/json
object
key
additional properties
string
Example generated

          

           

            {
           

          

          

           

             
            "additionalProperty"
            : 
            "
            example
            "
           

          

          

           

            }