CredentialDataRequest
public
class
CredentialDataRequest
extends Object
| java.lang.Object | |
| ↳ | android.security.identity.CredentialDataRequest |
This class was deprecated
in API level 10000.
Use java.security.KeyStore with the Android hardware-backed keystore instead.
An object representing a request for credential data.
Summary
Nested classes | |
|---|---|
class |
CredentialDataRequest.Builder
This class was deprecated
in API level 10000.
Use |
Public methods | |
|---|---|
Map<String, Collection<String>>
|
getDeviceSignedEntriesToRequest()
This method is deprecated.
Use |
Map<String, Collection<String>>
|
getIssuerSignedEntriesToRequest()
This method is deprecated.
Use |
byte[]
|
getReaderSignature()
This method is deprecated.
Use |
byte[]
|
getRequestMessage()
This method is deprecated.
Use |
boolean
|
isAllowUsingExhaustedKeys()
This method is deprecated.
Use |
boolean
|
isAllowUsingExpiredKeys()
This method is deprecated.
Use |
boolean
|
isIncrementUseCount()
This method is deprecated.
Use |
Inherited methods | |
|---|---|
Public methods
getDeviceSignedEntriesToRequest
public Map<String, Collection<String>> getDeviceSignedEntriesToRequest ()
This method is deprecated.
Use java.security.KeyStore with the Android hardware-backed keystore
instead.
Gets the device-signed entries to request.
| Returns | |
|---|---|
Map<String, Collection<String>> |
the device-signed entries to request.
This value cannot be null. |
getIssuerSignedEntriesToRequest
public Map<String, Collection<String>> getIssuerSignedEntriesToRequest ()
This method is deprecated.
Use java.security.KeyStore with the Android hardware-backed keystore
instead.
Gets the issuer-signed entries to request.
| Returns | |
|---|---|
Map<String, Collection<String>> |
the issuer-signed entries to request.
This value cannot be null. |
getReaderSignature
public byte[] getReaderSignature ()
This method is deprecated.
Use java.security.KeyStore with the Android hardware-backed keystore
instead.
Gets the reader signature.
This data structure is described in the documentation for the
PresentationSession.getCredentialData(String,CredentialDataRequest) method.
| Returns | |
|---|---|
byte[] |
a COSE_Sign1 structure as described above.
This value may be null. |
getRequestMessage
public byte[] getRequestMessage ()
This method is deprecated.
Use java.security.KeyStore with the Android hardware-backed keystore
instead.
Gets the request message CBOR.
This data structure is described in the documentation for the
PresentationSession.getCredentialData(String,CredentialDataRequest) method.
| Returns | |
|---|---|
byte[] |
the request message CBOR as described above.
This value may be null. |
isAllowUsingExhaustedKeys
public boolean isAllowUsingExhaustedKeys ()
This method is deprecated.
Use java.security.KeyStore with the Android hardware-backed keystore
instead.
Gets whether to allow using an authentication key which use count has been exceeded.
By default this is set to true.
| Returns | |
|---|---|
boolean |
whether to allow using an authentication key which use count has been exceeded if no other key is available. |
isAllowUsingExpiredKeys
public boolean isAllowUsingExpiredKeys ()
This method is deprecated.
Use java.security.KeyStore with the Android hardware-backed keystore
instead.
Gets whether to allow using an authentication key which is expired.
By default this is set to false.
| Returns | |
|---|---|
boolean |
whether to allow using an authentication key which is expired if no other key is available. |
isIncrementUseCount
public boolean isIncrementUseCount ()
This method is deprecated.
Use java.security.KeyStore with the Android hardware-backed keystore
instead.
Gets whether to increment the use-count for the authentication key used.
By default this is set to true.
| Returns | |
|---|---|
boolean |
whether to increment the use count of the authentication key used. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-07-20 UTC.