-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(feat): add credential revocation (#325)
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |