Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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.

...

TypeNameDescriptionQualificationSchema
Body

request

Request body parameters, see schema for details.

Required

RevokedUsersWithTransaction

Responses

HTTP CodeCommon messagesvvDescriptionSchema
200

Contains a transaction ID and lists of revoked and non-revoked participants.

RevokeParticipantAccessResponse

400The 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

string
500An 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

  • the user of the parameter 'users' is empty.
  • the parameter 'type' of User is missing.
string

Security

TypeName
apiKeyKey

...