Stay organized with collections
Save and categorize content based on your preferences.
public abstract class SignalCredentialStateRequest
Base request class for sending credential state signals to providers.
An application can construct a subtype request and call CredentialManager.signalCredentialState to propagate a signal credential state request.
Summary
Public methods
public 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)
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 2025-08-13 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-13 UTC."],[],[],null,["# SignalCredentialStateRequest\n============================\n\nArtifact: [androidx.credentials:credentials](/jetpack/androidx/releases/credentials) \n[View Source](https://cs.android.com/search?q=file:androidx/credentials/SignalCredentialStateRequest.kt+class:androidx.credentials.SignalCredentialStateRequest) \nAdded in [1.6.0-alpha05](/jetpack/androidx/releases/credentials#1.6.0-alpha05)\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/androidx/credentials/SignalCredentialStateRequest \"View this page in Kotlin\") \\|Java\n\n\n```\npublic abstract class SignalCredentialStateRequest\n```\n\n\u003cbr /\u003e\n\nKnown direct subclasses \n[SignalAllAcceptedCredentialIdsRequest](/reference/androidx/credentials/SignalAllAcceptedCredentialIdsRequest), [SignalCurrentUserDetailsRequest](/reference/androidx/credentials/SignalCurrentUserDetailsRequest), [SignalUnknownCredentialRequest](/reference/androidx/credentials/SignalUnknownCredentialRequest) \n\n|----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| [SignalAllAcceptedCredentialIdsRequest](/reference/androidx/credentials/SignalAllAcceptedCredentialIdsRequest) | A request to signal the complete list of public key credentials ids for a given user. |\n| [SignalCurrentUserDetailsRequest](/reference/androidx/credentials/SignalCurrentUserDetailsRequest) | A request to signal the user's current name and display name. |\n| [SignalUnknownCredentialRequest](/reference/androidx/credentials/SignalUnknownCredentialRequest) | A request to signal that a credential ID was not recognized by the relying party. |\n\n*** ** * ** ***\n\nBase request class for sending credential state signals to providers.\n\nAn application can construct a subtype request and call [CredentialManager.signalCredentialState](/reference/androidx/credentials/CredentialManager#signalCredentialState(androidx.credentials.SignalCredentialStateRequest)) to propagate a signal credential state request.\n\nSummary\n-------\n\n| ### Public methods |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `static final @`[NonNull](/reference/androidx/annotation/NonNull)` `[SignalCredentialStateRequest](/reference/androidx/credentials/SignalCredentialStateRequest) | [createFrom](/reference/androidx/credentials/SignalCredentialStateRequest#createFrom(kotlin.String,kotlin.String,kotlin.String))`(` ` @`[NonNull](/reference/androidx/annotation/NonNull)` `[String](https://developer.android.com/reference/java/lang/String.html)` requestType,` ` @`[NonNull](/reference/androidx/annotation/NonNull)` `[String](https://developer.android.com/reference/java/lang/String.html)` requestJson,` ` `[String](https://developer.android.com/reference/java/lang/String.html)` origin` `)` |\n| `final `[String](https://developer.android.com/reference/java/lang/String.html) | [getOrigin](/reference/androidx/credentials/SignalCredentialStateRequest#getOrigin())`()` the origin of a different application if the request is being made on behalf of that application (Note: for API level \\\u003e=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present) |\n| `final @`[NonNull](/reference/androidx/annotation/NonNull)` `[Bundle](https://developer.android.com/reference/android/os/Bundle.html) | [getRequestData](/reference/androidx/credentials/SignalCredentialStateRequest#getRequestData())`()` the bundle to contain the request json and any additional info |\n| `final @`[NonNull](/reference/androidx/annotation/NonNull)` `[String](https://developer.android.com/reference/java/lang/String.html) | [getRequestJson](/reference/androidx/credentials/SignalCredentialStateRequest#getRequestJson())`()` the signal request data in the expected json format |\n| `final @`[NonNull](/reference/androidx/annotation/NonNull)` `[String](https://developer.android.com/reference/java/lang/String.html) | [getType](/reference/androidx/credentials/SignalCredentialStateRequest#getType())`()` the request type representing one of [SignalAllAcceptedCredentialIdsRequest](/reference/androidx/credentials/SignalAllAcceptedCredentialIdsRequest), [SignalCurrentUserDetailsRequest](/reference/androidx/credentials/SignalCurrentUserDetailsRequest) and [SignalUnknownCredentialRequest](/reference/androidx/credentials/SignalUnknownCredentialRequest)) |\n\nPublic methods\n--------------\n\n### createFrom\n\nAdded in [1.6.0-alpha05](/jetpack/androidx/releases/credentials#1.6.0-alpha05) \n\n```\npublic static final @NonNull SignalCredentialStateRequest createFrom(\n @NonNull String requestType,\n @NonNull String requestJson,\n String origin\n)\n``` \n\n### getOrigin\n\nAdded in [1.6.0-alpha05](/jetpack/androidx/releases/credentials#1.6.0-alpha05) \n\n```\npublic final String getOrigin()\n```\n\nthe origin of a different application if the request is being made on behalf of that application (Note: for API level \\\u003e=34, setting a non-null value for this parameter will throw a SecurityException if android.permission.CREDENTIAL_MANAGER_SET_ORIGIN is not present) \n\n### getRequestData\n\nAdded in [1.6.0-alpha05](/jetpack/androidx/releases/credentials#1.6.0-alpha05) \n\n```\npublic final @NonNull Bundle getRequestData()\n```\n\nthe bundle to contain the request json and any additional info \n\n### getRequestJson\n\nAdded in [1.6.0-alpha05](/jetpack/androidx/releases/credentials#1.6.0-alpha05) \n\n```\npublic final @NonNull String getRequestJson()\n```\n\nthe signal request data in the expected json format \n\n### getType\n\nAdded in [1.6.0-alpha05](/jetpack/androidx/releases/credentials#1.6.0-alpha05) \n\n```\npublic final @NonNull String getType()\n```\n\nthe request type representing one of [SignalAllAcceptedCredentialIdsRequest](/reference/androidx/credentials/SignalAllAcceptedCredentialIdsRequest), [SignalCurrentUserDetailsRequest](/reference/androidx/credentials/SignalCurrentUserDetailsRequest) and [SignalUnknownCredentialRequest](/reference/androidx/credentials/SignalUnknownCredentialRequest))"]]
