Organisation wallet units

Update organisation wallet unit revocation status

PUT/v4/config/ows/wallet-provider/organisation-wallet-units/{walletUnitId}/revocation-status

Revokes or suspends every Wallet Unit Attestation (WUA) of an organisation wallet unit (TS3 section 2.5.1): the wallet provider sets each status list entry of its WUAs, every WUA of its pools included, and the copies that the holder organisation keeps follow. In the same change the wallet unit loses its authorisation (isAuthorised: false, attestationStatus: revoked), so it gets no new WUA until you authorise it again with Update organisation wallet unit and fill its pool with Issue organisation wallet unit attestations.

revocationStatus is Revoked or Suspended; Operational is refused. To make WUAs valid again, change their row with Update organisation wallet unit issuance history revocation status. The key attestations of the wallet unit do not change.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/ows/wallet-provider/organisation-wallet-units/{walletUnitId}/revocation-status' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "revocationStatus": "Revoked"
}'

{
  "revocationStatus": "Revoked",
  "organisationWalletUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "revokedEntries": 3
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:organisation-wallet-units:revoke

Path parameters

walletUnitIdstring<uuid>required
The id of the wallet unit, from the list of the wallet units of its kind. The routes of each kind read only their kind: the id of an organisation wallet unit gives 404 on an individual wallet unit route, and the other way round. A deleted wallet unit also gives 404.

Body

application/json

The new status of the WUAs of the wallet unit.

revocationStatusenum<string>required
Required. Revoked or Suspended makes the attestations invalid on their status lists. The revocation of a wallet unit does not take Operational: the API rejects it with 400 (Invalid request: revocationStatus must be Revoked or Suspended for the revocation of a wallet unit; got Operational.). To make one attestation valid again, change the revocation status of its issuance history row.
Available options:Revoked,Suspended
Example:"Revoked"

Response

application/json

The status that the wallet provider set, and the number of entries that it changed.

revocationStatusenum<string>
The status that the wallet provider set (Revoked or Suspended).
Available options:Revoked,Suspended
organisationWalletUnitIdstring<uuid>
The id of the wallet unit.
revokedEntriesinteger
The distinct status list entries that the wallet provider set.
Example:3