multipaz-android-legacy/com.android.identity.android.legacy/IdentityCredential/delete

delete

@NonNull
open fun delete(@NonNull challenge: Array<Byte>): Array<Byte>

Deletes a credential.

This method returns a COSE_Sign1 data structure signed by the CredentialKey with payload set to ProofOfDeletion as defined below.

    ProofOfDeletion = [
         "ProofOfDeletion",            ; tstr
         tstr,                         ; DocType
         bstr,                         ; Challenge
         bool                          ; true if this is a test credential, should
                                       ; always be false.
     ]
Content copied to clipboard

This is only implemented on FEATURE_VERSION_202101, fails with UnsupportedOperationException if using a store with a lesser version.

Return

the COSE_Sign1 data structure above

Parameters

challenge

is a non-empty byte array whose contents should be unique, fresh and provided by the issuing authority. The value provided is embedded in the generated CBOR and enables the issuing authority to verify that the returned proof is fresh.