...
...
...
...
| Info |
|---|
For this function to work, the Revoke service must be activated when the transaction is created. |
Description
Revokes participant access to a transaction. This causes the CDI server to try to revoke all participant accesses in the provided list. The returned data contains two lists, one with all revoked participants and one with any participant that could not be revoked.
| Info |
|---|
A participant cannot be revoked if they have already opened or signed the transaction. If so, the content is already known to them, making it impossible to revoke their access to it. |
HTTP Method | URI Scheme |
|---|---|
POST | /server/transaction/participant-access/revoke |
Parameters
Type | Name | Description | Qualification | Schema |
|---|---|---|---|---|
Body | request | Request body parameters, see schema for details. | Required |
Responses
HTTP Code | Common |
|---|
messages | Description | Schema | |
|---|---|---|---|
200 | Contains a transaction ID and lists of revoked and non-revoked participants. | ||
400 | The application with the specified key could not be found | String | |
An error has occurred | This error message is returned when
| String | |
Invalid role ID format | This error message is returned when
| String | |
500 | An unexpected error occurred: null | This error is returned when the parameter 'users' is missing. | String |
An unexpected error occurred: Unknown user type null | This error message is returned when
| String |
Security
Type | Name |
|---|---|
apiKey |