Individual wallet units

Update individual wallet unit

PUT/v4/config/ows/wallet-provider/individual-wallet-units/{walletUnitId}

Changes the client id, the credential offer URL, the public key or the authorisation of an individual wallet unit. A member that you leave out keeps its value.

isAuthorised: false on an authorised wallet unit is the kill switch. In the same change, the wallet provider revokes (Revoked) every active Wallet Unit Attestation (WUA) of the wallet unit on its status list, so an issuer that checks the status refuses the wallet at once, and the wallet unit gets no new WUA. The key attestations of the wallet unit do not change. isAuthorised: true lets the wallet unit get new WUAs again; the revoked WUAs stay revoked.

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/ows/wallet-provider/individual-wallet-units/{walletUnitId}' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "clientUrl": "https://wallet.example.com/app",
  "isAuthorised": true
}'

{
  "individualWalletUnit": {
    "id": "6bf3bd97-50ba-4fec-9a78-1076b5627b5a",
    "clientId": "wallet-unit-4f2a9c71",
    "clientUrl": "https://wallet.example.com/app",
    "clientPublicKey": {
      "kty": "EC",
      "crv": "P-256",
      "x": "Nbii9ohvDybKefFdAx4QfqqUAKPyZnihqOHDp3Z2jEA",
      "y": "DeBO5yAoahfS3HqfDmvrVsXvCzDrco4WLJ5wVIvTZ5s"
    },
    "isAuthorised": true,
    "clientMetadata": null,
    "attestationStatus": "authorised",
    "attestationExpiresAt": 0,
    "createdAt": 1794149364,
    "updatedAt": 1794149365,
    "devicePlatform": "android",
    "deviceIntegrityToken": "",
    "deviceKeyId": "",
    "assertionToken": "",
    "assertionTokenType": ""
  }
}

Authorizations

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

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 members to change.

clientIdstring
A new client id for the wallet unit. No other individual wallet unit, also a deleted one, may have it.
Example:"urn:ietf:params:oauth:jwk-thumbprint:sha-256:NzbLsXh8uDCcd-6MNwXF4W_7noWXFZAfHkxZsRGC9Xs"
clientUrlstring
A new credential offer URL of the wallet.
Example:"openid-credential-offer://"
clientPublicKeyobject
A new public key (JWK) of the wallet unit: an EC key on P-256, P-384 or P-521 with kty, crv, x and y, and no private member.
isAuthorisedboolean
true authorises the wallet unit: it can get Wallet Unit Attestations again. false on an authorised wallet unit is the kill switch: the wallet provider also revokes every active WUA of the wallet unit, in the same change.
Example:true

Response

application/json

The individual wallet unit after the change.

individualWalletUnitobject
The individual wallet unit after the change.