# CredentialOption

Artifact: [androidx.credentials:credentials](https://developer.android.com/jetpack/androidx/releases/credentials) [View Source](https://cs.android.com/search?q=file:androidx/credentials/CredentialOption.kt+class:androidx.credentials.CredentialOption) Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

*** ** * ** ***

<br />

```
public abstract class CredentialOption
```

<br />

Known direct subclasses [GetCustomCredentialOption](https://developer.android.com/reference/androidx/credentials/GetCustomCredentialOption), [GetDigitalCredentialOption](https://developer.android.com/reference/androidx/credentials/GetDigitalCredentialOption), [GetPasswordOption](https://developer.android.com/reference/androidx/credentials/GetPasswordOption), [GetPublicKeyCredentialOption](https://developer.android.com/reference/androidx/credentials/GetPublicKeyCredentialOption), [GetRestoreCredentialOption](https://developer.android.com/reference/androidx/credentials/GetRestoreCredentialOption)

|---|---|
| `https://developer.android.com/reference/androidx/credentials/GetCustomCredentialOption` | Allows extending custom versions of GetCredentialOptions for unique use cases. |
| `https://developer.android.com/reference/androidx/credentials/GetDigitalCredentialOption` | A request to retrieve the user's digital credential, normally used for verification or sign-in purpose. |
| `https://developer.android.com/reference/androidx/credentials/GetPasswordOption` | A request to retrieve the user's saved application password from their password provider. |
| `https://developer.android.com/reference/androidx/credentials/GetPublicKeyCredentialOption` | A request to get passkeys from the user's public key credential provider. |
| `https://developer.android.com/reference/androidx/credentials/GetRestoreCredentialOption` | A request to get the restore credential from the restore credential provider. |

*** ** * ** ***

Base class for getting a specific type of credentials.

`https://developer.android.com/reference/androidx/credentials/GetCredentialRequest` will be composed of a list of `https://developer.android.com/reference/androidx/credentials/CredentialOption` subclasses to indicate the specific credential types and configurations that your app accepts.

The `https://developer.android.com/reference/androidx/credentials/CredentialOption#typePriorityHint()` value helps decide where the credential will be displayed on the selector. It is used with more importance than signals like 'last recently used' but with less importance than other signals, such as the ordering of displayed accounts. It is expected to be one of the defined `https://developer.android.com/reference/androidx/credentials/CredentialOption.PriorityHints` constants. By default, `https://developer.android.com/reference/androidx/credentials/GetCustomCredentialOption` will have `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_DEFAULT()`, `https://developer.android.com/reference/androidx/credentials/GetPasswordOption` will have `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_PASSWORD_OR_SIMILAR()` and `https://developer.android.com/reference/androidx/credentials/GetPublicKeyCredentialOption` will have `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_PASSKEY_OR_SIMILAR()`. It is expected that `https://developer.android.com/reference/androidx/credentials/GetCustomCredentialOption` types will remain unchanged unless strong reasons arise and cannot ever have `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_PASSKEY_OR_SIMILAR()`. Given passkeys prevent many security threats that other credentials do not, we enforce that nothing is shown higher than passkey types in order to provide end users with the safest credentials first. See the spec [here](https://w3c.github.io/webauthn/) for more information on passkeys.

## Summary

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_DEFAULT() = 2000` Default value of display priority. |
| `static final int` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_OIDC_OR_SIMILAR() = 500` Value of display priority for OpenID credentials or those of similar security level. |
| `static final int` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_PASSKEY_OR_SIMILAR() = 100` Value of display priority for passkeys or credentials of similar security level. |
| `static final int` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#PRIORITY_PASSWORD_OR_SIMILAR() = 1000` Value of display priority for passwords or credentials of similar security level. |

| ### Public methods |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/CredentialOption` | `@https://developer.android.com/reference/androidx/annotation/RequiresApi(value = 34) https://developer.android.com/reference/androidx/credentials/CredentialOption#createFrom(android.credentials.CredentialOption)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/credentials/CredentialOption.html option)` Parses the `https://developer.android.com/reference/androidx/credentials/CredentialOption.Companion#createFrom(android.credentials.CredentialOption)` into an instance of `https://developer.android.com/reference/androidx/credentials/CredentialOption`. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/credentials/CredentialOption` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#createFrom(kotlin.String,android.os.Bundle,android.os.Bundle,kotlin.Boolean,kotlin.collections.Set)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html type, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html requestData, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html candidateQueryData, boolean requireSystemProvider, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/ComponentName.html> allowedProviders )` Parses the raw data into an instance of `https://developer.android.com/reference/androidx/credentials/CredentialOption`. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/ComponentName.html>` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#getAllowedProviders()()` a set of provider service `https://developer.android.com/reference/android/content/ComponentName.html` allowed to receive this option (Note: a `https://developer.android.com/reference/java/lang/SecurityException.html` will be thrown if it is set as non-empty but your app does not have android.permission.CREDENTIAL_MANAGER_SET_ALLOWED_PROVIDERS; empty means every provider is eligible; for API level \< 34, this property will not take effect and you should control the allowed provider via [library dependencies](https://developer.android.com/training/sign-in/passkeys#add-dependencies)) |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#getCandidateQueryData()()` the partial request data in the `https://developer.android.com/reference/android/os/Bundle.html` format that will be sent to the provider during the initial candidate query stage, which will not contain sensitive user information |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#getRequestData()()` the request data in the `https://developer.android.com/reference/android/os/Bundle.html` format |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#getType()()` the credential type determined by the credential-type-specific subclass (e.g. the type for `https://developer.android.com/reference/androidx/credentials/GetPasswordOption` is `https://developer.android.com/reference/androidx/credentials/PasswordCredential#TYPE_PASSWORD_CREDENTIAL()` and for `https://developer.android.com/reference/androidx/credentials/GetPublicKeyCredentialOption` is `https://developer.android.com/reference/androidx/credentials/PublicKeyCredential#TYPE_PUBLIC_KEY_CREDENTIAL()`) |
| `final int` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#getTypePriorityHint()()` sets the priority of this entry, which defines how it appears in the credential selector, with less precedence than account ordering but more precedence than last used time; see `https://developer.android.com/reference/androidx/credentials/CredentialOption.PriorityHints` for more information |
| `final boolean` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#isAutoSelectAllowed()()` whether a credential entry will be automatically chosen if it is the only one available option |
| `final boolean` | `https://developer.android.com/reference/androidx/credentials/CredentialOption#isSystemProviderRequired()()` true if must only be fulfilled by a system provider and false otherwise |

## Constants

### PRIORITY_DEFAULT

```
public static final int PRIORITY_DEFAULT = 2000
```

Default value of display priority.

### PRIORITY_OIDC_OR_SIMILAR

```
public static final int PRIORITY_OIDC_OR_SIMILAR = 500
```

Value of display priority for OpenID credentials or those of similar security level.

### PRIORITY_PASSKEY_OR_SIMILAR

```
public static final int PRIORITY_PASSKEY_OR_SIMILAR = 100
```

Value of display priority for passkeys or credentials of similar security level.

### PRIORITY_PASSWORD_OR_SIMILAR

```
public static final int PRIORITY_PASSWORD_OR_SIMILAR = 1000
```

Value of display priority for passwords or credentials of similar security level.

## Public methods

### createFrom

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
@RequiresApi(value = 34)
public static final @NonNull CredentialOption createFrom(@NonNull CredentialOption option)
```

Parses the `https://developer.android.com/reference/androidx/credentials/CredentialOption.Companion#createFrom(android.credentials.CredentialOption)` into an instance of `https://developer.android.com/reference/androidx/credentials/CredentialOption`.

It is recommended to construct a CredentialOption by directly instantiating a CredentialOption subclass, instead of using this API. This API should only be used by a small subset of system apps that reconstruct an existing object for user interactions such as collecting consents.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/credentials/CredentialOption.html option` | the framework CredentialOption object |

### createFrom

Added in [1.5.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.5.0)

```
public static final @NonNull CredentialOption createFrom(
    @NonNull String type,
    @NonNull Bundle requestData,
    @NonNull Bundle candidateQueryData,
    boolean requireSystemProvider,
    @NonNull Set<@NonNull ComponentName> allowedProviders
)
```

Parses the raw data into an instance of `https://developer.android.com/reference/androidx/credentials/CredentialOption`.

It is recommended to construct a CredentialOption by directly instantiating a CredentialOption subclass, instead of using this API. This API should only be used by a small subset of system apps that reconstruct an existing object for user interactions such as collecting consents.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html type` | matches `https://developer.android.com/reference/androidx/credentials/CredentialOption#type()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html requestData` | matches `https://developer.android.com/reference/androidx/credentials/CredentialOption#requestData()`, the request data in the `https://developer.android.com/reference/android/os/Bundle.html` format; this should be constructed and retrieved from the a given `https://developer.android.com/reference/androidx/credentials/CredentialOption` itself and never be created from scratch |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Bundle.html candidateQueryData` | matches `https://developer.android.com/reference/androidx/credentials/CredentialOption#candidateQueryData()`; this should be constructed and retrieved from the a given `https://developer.android.com/reference/androidx/credentials/CredentialOption` itself and never be created from scratch |
| `boolean requireSystemProvider` | matches `https://developer.android.com/reference/androidx/credentials/CredentialOption#isSystemProviderRequired()` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Set.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/content/ComponentName.html> allowedProviders` | matches `https://developer.android.com/reference/androidx/credentials/CredentialOption#allowedProviders()`, empty means every provider is eligible |

### getAllowedProviders

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

```
public final @NonNull Set<@NonNull ComponentName> getAllowedProviders()
```

a set of provider service `https://developer.android.com/reference/android/content/ComponentName.html` allowed to receive this option (Note: a `https://developer.android.com/reference/java/lang/SecurityException.html` will be thrown if it is set as non-empty but your app does not have android.permission.CREDENTIAL_MANAGER_SET_ALLOWED_PROVIDERS; empty means every provider is eligible; for API level \< 34, this property will not take effect and you should control the allowed provider via [library dependencies](https://developer.android.com/training/sign-in/passkeys#add-dependencies))

### getCandidateQueryData

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

```
public final @NonNull Bundle getCandidateQueryData()
```

the partial request data in the `https://developer.android.com/reference/android/os/Bundle.html` format that will be sent to the provider during the initial candidate query stage, which will not contain sensitive user information

### getRequestData

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

```
public final @NonNull Bundle getRequestData()
```

the request data in the `https://developer.android.com/reference/android/os/Bundle.html` format

### getType

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

```
public final @NonNull String getType()
```

the credential type determined by the credential-type-specific subclass (e.g. the type for `https://developer.android.com/reference/androidx/credentials/GetPasswordOption` is `https://developer.android.com/reference/androidx/credentials/PasswordCredential#TYPE_PASSWORD_CREDENTIAL()` and for `https://developer.android.com/reference/androidx/credentials/GetPublicKeyCredentialOption` is `https://developer.android.com/reference/androidx/credentials/PublicKeyCredential#TYPE_PUBLIC_KEY_CREDENTIAL()`)

### getTypePriorityHint

Added in [1.3.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.3.0)

```
public final int getTypePriorityHint()
```

sets the priority of this entry, which defines how it appears in the credential selector, with less precedence than account ordering but more precedence than last used time; see `https://developer.android.com/reference/androidx/credentials/CredentialOption.PriorityHints` for more information

### isAutoSelectAllowed

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

```
public final boolean isAutoSelectAllowed()
```

whether a credential entry will be automatically chosen if it is the only one available option

### isSystemProviderRequired

Added in [1.2.0](https://developer.android.com/jetpack/androidx/releases/credentials#1.2.0)

```
public final boolean isSystemProviderRequired()
```

true if must only be fulfilled by a system provider and false otherwise