Skip to content

Commit

Permalink
docs(feat): add credential revocation (#325)
Browse files Browse the repository at this point in the history
  • Loading branch information
jjeroch authored May 27, 2024
1 parent 5037ff8 commit 91fd461
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/user/06. Certificates/04. Credential Revocation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## Credential Revocation

### Overview

The credential revocation function allows authorized individuals to revoke issued credentials that are currently active. This action is irreversible and will invalidate the credential, ensuring it is no longer recognized as valid within any transactions.

### How to Revoke a Credential

If you have been granted the "revoke_credentials_issuer" permission, you can revoke active credentials via the issuer admin board. Follow the steps below to carry out a revocation:

1. **Locate the Credential**: Navigate to the issuer admin board and find the active credential you wish to revoke.

2. **Initiate Revocation**: Click on the revoke icon (represented by a circular arrow) next to the credential you want to revoke.

<img width="70" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/credential-revocation-icon.png">

3. **Confirm Your Action**: After clicking the revoke icon, a confirmation overlay will appear. Carefully review the details, then select "Confirm" to proceed with the revocation or "Cancel" to abort the process.

<img width="300" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/credential-revocation-overlay.png">

4. **Revocation Process**: A loading indicator will appear while the system processes the revocation. Once complete, you will receive a notification indicating the outcome of your action.

### Notifications

- **Success**: You will receive a confirmation message stating that the credential has been successfully revoked and is no longer valid.
- **Error**: If the revocation fails, an error message will be displayed advising you to try again later or contact the site administrator.

### Important Considerations

- **Irreversible Action**: Revocation is a permanent action. Once a credential is revoked, it cannot be reinstated as valid.
- **Permission Required**: Only users with the "revoke_credentials_issuer" permission can perform revocations.
- **Immediate Effect**: The revocation takes effect immediately, and the credential's status will be updated to reflect this change.

<br>

## NOTICE

This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).

- SPDX-License-Identifier: Apache-2.0
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/portal-assets

0 comments on commit 91fd461

Please sign in to comment.