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.

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

HTTP Method	URI Scheme
POST	/server/transaction/participant-access/revoke

Parameters

Type	Name	Description	Qualification	Schema

Type	Name	Description	Qualification	Schema
Body	request	Request body parameters, see schema for details.	Required	RevokedUsersWithTransaction

Responses

HTTP Code	Common messages	Description	Schema

HTTP Code	Common messages	Description	Schema
200		Contains a transaction ID and lists of revoked and non-revoked participants.	RevokeParticipantAccessResponse
400	The application with the specified key could not be found		String
	An error has occurred	This error message is returned when the parameter 'transaction' is of the wrong value. the parameter 'users' is not specified. the 'REVOKE' service type of Service has the value “false” specified when the transaction was created.	String
	Invalid role ID format	This error message is returned when the parameter 'privateId' of User is missing. the parameter 'corporateId' of User is missing.	String
500	An unexpected error occurred: null	This error is returned when the parameter 'users' is missing.	String
500	An unexpected error occurred: Unknown user type null	This error message is returned when the user of the parameter 'users' is empty. the parameter 'type' of User is missing.	String

Security

Type	Name

Type	Name
apiKey	Key

Developer 5.2

Revoke participant accesses

Description

Parameters

Responses

Security