Configure your Android app

You can configure your Android app statically by editing the strings.xml file, located in app/src/main/res/values.

To configure your Android app programmatically, refer to Dynamic configuration.

Configuration strings

The required configuration strings are as follows:

Property Description

Property	Description
`forgerock_oauth_client_id`	The `client_id` of the OAuth 2.0 client profile to use.
`forgerock_oauth_redirect_uri`	The `redirect_uri` as configured in the OAuth 2.0 client profile.
`forgerock_oauth_scope`	A list of scopes to request when performing an OAuth 2.0 authorization flow.
`forgerock_oauth_threshold`	A threshold, in seconds, to refresh an OAuth 2.0 token before the `access_token` expires (defaults to `30` seconds).
`forgerock_url`	The base URL of the AM instance to connect to, including port and deployment path; for example, `https://openam.example.com:8443/openam`.
`forgerock_realm`	The realm in which the OAuth 2.0 client profile is configured (defaults to the top-level realm; `root`).
`forgerock_timeout`	A timeout, in seconds, for each request that communicates with AM.
`forgerock`	The name of the account provider displayed by Android when using single sign-on, for example "ForgeRock Tutorial App".
`forgerock_account_name`	The name of the user account displayed by Android when using single sign-on, for example "ForgeRock".
`forgerock_webauthn_account_name`	The account name where the Android SDK persists the key handle and user information (`PublicKeyCredentialSource`), in order to support "usernameless" WebAuthn flows. Default value is "WebAuthn". Note that this property is only applicable when SSO is enabled. When SSO is disabled, the key handle and user information are persisted in the Android SharedPreferences.
`forgerock_webauthn_max_credential`	The maximum number of key handles and user information (`PublicKeyCredentialSource`) to be persisted by the SDK. Default value is 10.
`forgerock_auth_service`	The name of the user *authentication* tree configured in AM.
`forgerock_cookie_name`	The name of the cookie that contains the SSO token, for example `iPlanetDirectoryPro`.

forgerock_oauth_client_id

The client_id of the OAuth 2.0 client profile to use.

forgerock_oauth_redirect_uri

The redirect_uri as configured in the OAuth 2.0 client profile.

forgerock_oauth_scope

A list of scopes to request when performing an OAuth 2.0 authorization flow.

forgerock_oauth_threshold

A threshold, in seconds, to refresh an OAuth 2.0 token before the access_token expires (defaults to 30 seconds).

forgerock_url

The base URL of the AM instance to connect to, including port and deployment path; for example, https://openam.example.com:8443/openam.

forgerock_realm

The realm in which the OAuth 2.0 client profile is configured (defaults to the top-level realm; root).

forgerock_timeout

A timeout, in seconds, for each request that communicates with AM.

forgerock

The name of the account provider displayed by Android when using single sign-on, for example "ForgeRock Tutorial App".

forgerock_account_name

The name of the user account displayed by Android when using single sign-on, for example "ForgeRock".

forgerock_webauthn_account_name

The account name where the Android SDK persists the key handle and user information (PublicKeyCredentialSource), in order to support "usernameless" WebAuthn flows. Default value is "WebAuthn".

Note that this property is only applicable when SSO is enabled. When SSO is disabled, the key handle and user information are persisted in the Android SharedPreferences.

forgerock_webauthn_max_credential

The maximum number of key handles and user information (PublicKeyCredentialSource) to be persisted by the SDK. Default value is 10.

forgerock_auth_service

The name of the user authentication tree configured in AM.

forgerock_cookie_name

The name of the cookie that contains the SSO token, for example iPlanetDirectoryPro.

To locate the cookie name in an Identity Cloud tenant, go to Tenant Settings > Global Settings > Server.

ForgeRock SDKs

Configure your Android app

Configuration strings