GetGoogleIdOption

Kotlin |Java

class GetGoogleIdOption : GetCustomCredentialOption

kotlin.Any
↳	androidx.credentials.CredentialOption
	↳	androidx.credentials.GetCustomCredentialOption
		↳	com.google.android.libraries.identity.googleid.GetGoogleIdOption

---

A request to retrieve user's Google ID Token.

Throws
java.lang.IllegalArgumentException	If serverClientId is empty
java.lang.IllegalArgumentException	If both filterByAuthorizedAccounts and requestVerifiedPhoneNumber are true.
com.google.android.libraries.identity.googleid.GoogleIdTokenParsingException	If any error encountered in creating GetGoogleIdOption from bundle.

Summary

Nested types
class GetGoogleIdOption.Builder A Builder for GetGoogleIdOption.

Public companion functions
GetGoogleIdOption	createFrom(data: Bundle) Helper function to create GetGoogleIdOption out of given Bundle.

Public constructors
GetGoogleIdOption(     serverClientId: String,     nonce: String?,     filterByAuthorizedAccounts: Boolean,     linkedServiceId: String?,     idTokenDepositionScopes: List<String>?,     requestVerifiedPhoneNumber: Boolean,     autoSelectEnabled: Boolean,     claims: List<Claim>?,     hostedDomainFilter: String? )

Public properties
Boolean	autoSelectEnabled sets the auto-select behavior in the request. sign-ups.
List<Claim>?	claims
Boolean	filterByAuthorizedAccounts whether to only allow the user to select from Google accounts that are already authorized to sign in to your application, default value is true
String?	hostedDomainFilter the domain to filter by (e.g., "example.com")
List<String>?	idTokenDepositionScopes Oauth scopes that Google will need to deposit a Google ID token to your application's backend server.
String?	linkedServiceId service ID used when linking accounts to a Google account
String?	nonce the nonce to use during ID token generation
Boolean	requestVerifiedPhoneNumber whether to request for a verified phone number during sign-ups.
String	serverClientId the client ID of the server to which the ID token will be issued

Inherited properties
From androidx.credentials.CredentialOption Set<ComponentName> allowedProviders Bundle candidateQueryData Boolean isAutoSelectAllowed Boolean isSystemProviderRequired Bundle requestData String type Int typePriorityHint

Public companion functions

createFrom

fun createFrom(data: Bundle): GetGoogleIdOption

Helper function to create GetGoogleIdOption out of given Bundle.

Parameters
data: Bundle	Bunble that contains all the necessary information about GetGoogleIdOption.

Public constructors

GetGoogleIdOption

GetGoogleIdOption(
    serverClientId: String,
    nonce: String? = null,
    filterByAuthorizedAccounts: Boolean = true,
    linkedServiceId: String? = null,
    idTokenDepositionScopes: List<String>? = null,
    requestVerifiedPhoneNumber: Boolean = false,
    autoSelectEnabled: Boolean = false,
    claims: List<Claim>? = null,
    hostedDomainFilter: String? = null
)

Public properties

autoSelectEnabled

val autoSelectEnabled: Boolean

sets the auto-select behavior in the request. sign-ups.

claims

val claims: List<Claim>?

filterByAuthorizedAccounts

val filterByAuthorizedAccounts: Boolean

whether to only allow the user to select from Google accounts that are already authorized to sign in to your application, default value is true

hostedDomainFilter

val hostedDomainFilter: String?

the domain to filter by (e.g., "example.com")

idTokenDepositionScopes

val idTokenDepositionScopes: List<String>?

Oauth scopes that Google will need to deposit a Google ID token to your application's backend server. This is optional and can be set to null. Only required if Google requires particular scopes to be able to deposit the ID token.

linkedServiceId

val linkedServiceId: String?

service ID used when linking accounts to a Google account

nonce

val nonce: String?

the nonce to use during ID token generation

requestVerifiedPhoneNumber

val requestVerifiedPhoneNumber: Boolean

whether to request for a verified phone number during sign-ups.

serverClientId

val serverClientId: String

the client ID of the server to which the ID token will be issued