SignalAllAcceptedCredentialIdsRequest

Artifact: androidx.credentials:credentials

Kotlin |Java

public final class SignalAllAcceptedCredentialIdsRequest extends SignalCredentialStateRequest

java.lang.Object
↳	androidx.credentials.SignalCredentialStateRequest
	↳	androidx.credentials.SignalAllAcceptedCredentialIdsRequest

A request to signal the complete list of public key credentials ids for a given user.

Summary

Public constructors
`SignalAllAcceptedCredentialIdsRequest(@NonNull String requestJson)` Constructs a request to signal the complete list of public key credentials ids for a given user.
`@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_SET_ORIGIN", conditional = true) SignalAllAcceptedCredentialIdsRequest( @NonNull String requestJson, String origin )` Constructs a request to signal the complete list of public key credentials ids for a given user.

Inherited methods

From androidx.credentials.SignalCredentialStateRequest

`final String`	`getOrigin()` the origin of a different application if the request is being made on behalf of that application (Note: for API level >=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present)
`final @NonNull Bundle`	`getRequestData()` the bundle to contain the request json and any additional info
`final @NonNull String`	`getRequestJson()` the signal request data in the expected json format
`final @NonNull String`	`getType()` the request type representing one of `SignalAllAcceptedCredentialIdsRequest`, `SignalCurrentUserDetailsRequest` and `SignalUnknownCredentialRequest`)

Public constructors

SignalAllAcceptedCredentialIdsRequest

Added in 1.6.0-beta03

public SignalAllAcceptedCredentialIdsRequest(@NonNull String requestJson)

Constructs a request to signal the complete list of public key credentials ids for a given user.

Parameters
`@NonNull String requestJson`	the request in JSON format. The format of the JSON should follow the WebAuthn Spec. Throws IllegalArgumentException if the json does not have the required keys according to the spec, or if base64url decoding fails for the user id or credential id.

SignalAllAcceptedCredentialIdsRequest

Added in 1.6.0-beta03

@RequiresPermission(value = "android.permission.CREDENTIAL_MANAGER_SET_ORIGIN", conditional = true)
public SignalAllAcceptedCredentialIdsRequest(
    @NonNull String requestJson,
    String origin
)

Constructs a request to signal the complete list of public key credentials ids for a given user.

Parameters

@NonNull String requestJson

the request in JSON format. The format of the JSON should follow the WebAuthn Spec. Throws IllegalArgumentException if the json does not have the required keys according to the spec, or if base64url decoding fails for the user id or credential id.

String origin

the origin of a different application if the request is being made on behalf of that application, to be used only by browsers or privileged apps recognized by the target credential provider (Note: if a non-browser/non-privileged app sets an origin, it will be rejected across all API levels, and for API level >=34, the calling party must also have the android.permission.CREDENTIAL_MANAGER_SET_ORIGIN permission otherwise a SecurityException will be thrown)

Throws
`kotlin.IllegalArgumentException`	if request json validation fails
`androidx.credentials.exceptions.publickeycredential.SignalCredentialSecurityException`	if origin is set without having android.permission.CREDENTIAl_MANAGER_SET_ORIGIN