Skip to main content
Device policy

Scan device policy

POST/v4/config/ows/wallet-provider/individual-wallet-unit-device-policy/scan

Checks the stored Android wallet units against the device policy: the units that are not deleted and not revoked, with the device data that their requests stored (the device model, the key attestation chain, and the latest attested security patch level and Android version). The scan applies the vulnerable device classes, the leaked attestation keys, and the device rules of the device policy configuration. A wallet unit that no rule matched and that has no stored device data that the rules need is counted in unknownDevice.

Run it first with dryRun: true to see what matches: the dry run is the preview of a change of the device rules. Without a dry run, the wallet provider revokes each matched wallet unit with the reason device_policy (the status Revoked on the status lists of its attestations). A revocation is final. The app of a revoked wallet unit shows "Wallet unit revoked" at its next status request.

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 options of the scan.

  • dryRunboolean

    true: count the matched wallet units and revoke nothing. false (default): revoke each matched wallet unit.

    Default:false

    Example:true

Response

application/json

The result of the scan.

  • matchedinteger

    The wallet units that the device policy refuses.

    Example:3

  • revokedinteger

    The wallet units that the scan revoked, with the reason device_policy. Always 0 for a dry run.

    Example:0

  • unknownDeviceinteger

    The wallet units that no rule matched and that have no stored device data that the rules need. The scan cannot check them.

    Example:315

  • matchesobject[]

    The first 100 matched wallet units, each with the reason of the match.