Individual wallet units

Update individual wallet unit keystore type revocation status

PUT/v4/config/ows/wallet-provider/individual-wallet-unit-keystore-types/revocation-status

Changes the status of one keystore type of the individual wallet units (TS3 section 2.5.2), for example after a weakness of a device keystore is known. Every key attestation of the type, of every individual wallet unit, gets the status on its status list entry, and the wallet provider records the status of the type. While the type is Revoked or Suspended, the wallet provider issues no new key attestation of it. Operational makes the key attestations of the type valid again and the type usable.

A type without key attestations is recorded too, so the status applies to its first key attestation. The key attestations of the organisation wallet units and every Wallet Unit Attestation stay as they are.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/ows/wallet-provider/individual-wallet-unit-keystore-types/revocation-status' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "attestationType": "android_keystore",
  "securityLevel": "strongbox",
  "devicePlatform": "android",
  "revocationStatus": "Revoked"
}'

{
  "revocationStatus": "Operational",
  "keystoreType": {
    "attestationType": "string",
    "securityLevel": "string",
    "devicePlatform": "android"
  },
  "revokedEntries": 1,
  "markedKeyAttestations": 12,
  "typeRegistered": true
}

Authorizations

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

Body

application/json

The keystore type and its new status.

attestationTypeenum<string>required
The kind of evidence of the key attestations of the type: software, android_keystore (the hardware Keystore of an Android device) or ios_app_attest (the Secure Enclave of an iOS device).
Available options:software,android_keystore,ios_app_attest
Example:"android_keystore"
securityLevelstringrequired
The keystore of the type: strongbox, tee, secure_enclave or software, optionally followed by : and the id of its certificate (a certified keystore).
Example:"strongbox"
devicePlatformenum<string>required
The device platform of the type.
Available options:android,ios
Example:"android"
revocationStatusenum<string>required
Revoked or Suspended makes the key attestations of the type invalid, and the wallet provider issues no new key attestation of the type. Operational makes them valid again and the type usable.
Available options:Operational,Revoked,Suspended
Example:"Revoked"

Response

application/json

The status that the wallet provider set, and what it changed.

revocationStatusenum<string>
The status that the wallet provider set.
Available options:Operational,Revoked,Suspended
keystoreTypeobject
The keystore type of the request.
revokedEntriesinteger
The distinct status list entries of the key attestations of the type that the wallet provider set: one shared entry with type_shared, one for each key attestation with per_ka.
Example:1
markedKeyAttestationsinteger
The key attestations whose revocationStatus changed.
Example:12
typeRegisteredboolean
Always true: the wallet provider recorded the status of the type, so it also applies to the key attestations that it issues later.