---
title: Configuring the Journey module on Android
description: PingOne Advanced Identity Cloud PingAM Android
component: orchsdks
page_id: orchsdks:journey:usage/android/03-configuring-the-journey-module
canonical_url: https://developer.pingidentity.com/orchsdks/journey/usage/android/03-configuring-the-journey-module.html
revdate: Tue, 2 Dec 2025 16:32:08 +0000
keywords: ["OAuth 2.0", "OpenID Connect", "Setup &amp; Configuration", "Source Code", "Integration", "SDK", "Android"]
section_ids:
  integrating_the_oidc_module: Integrating the OIDC Module
---

# Configuring the Journey module on Android

[icon: circle-check, set=far]PingOne Advanced Identity Cloud [icon: circle-check, set=far]PingAM [icon: android, set=fab]Android

* [Prepare](01-configuring-the-server.html)

* [Install](02-installing-the-journey-module.html)

* **Configure**

* [Start](04-starting-an-authentication-journey.html)

* [Navigate](05-navigating-an-authentication-journey.html)

* [Manage](06-handling-sessions.html)

You must configure the **Journey** module to connect to your Advanced Identity Cloud or PingAM server.

To configure the module, instantiate the `Journey` class and provide the configuration options as follows:

Configuring the `journey` module

```kotlin
val journey = Journey {
    serverUrl = "https://openam-forgerock-sdks.forgeblocks.com/am" // Specify the server URL
    realm = "alpha" // Specify the realm for authentication
    cookie = "ch15fefc5407912" // Specify the cookie name for session management
    logger = Logger.STANDARD // Optional. Logger the module uses to output messages
    httpClient = customHttpClient // Optional. Intercept and customize network requests
}
```

Update the following properties with values that match your environment:

* *serverUrl*

  The URL of the Access Management service on your server.

  * *Advanced Identity Cloud example:*

    `https://openam-forgerock-sdks.forgeblocks.com/am`

  * *PingAM example:*

    `https://openam.example.com:8443/openam`

* *realm*

  The realm containing your users and configuration.

  Usually, `root` for PingAM and `alpha` or `bravo` for Advanced Identity Cloud.

* *cookie*

  The name of the cookie your PingOne Advanced Identity Cloud tenant uses to store SSO tokens in client browsers.

  * On a self-hosted PingAM server this value is usually `iPlanetDirectoryPro`.

  * On servers, the cookie name is a random string of characters, such as `ch15fefc5407912`.

    > **Collapse: How do I find my PingOne Advanced Identity Cloud cookie name?**
    >
    > To locate the cookie name in an PingOne Advanced Identity Cloud tenant:
    >
    > 1. Navigate to Tenant settings > Global Settings
    >
    > 2. Copy the value of the Cookie property.

* *logger*

  The logger the module uses to output messages.

  Choose from, `STANDARD`, `WARN`, or `NONE`, or specify a custom logger to use.

  Learn more in [Customizing logging on Android](../../customization/logging/android-custom-logging.html).

* *httpClient*

  The HTTP client to use to customize network requests from the **Journey** module.

  Learn more in [Customizing requests from the Journey module on Android](../../customization/requests/android-request-interceptors.html).

## Integrating the OIDC Module

You can choose to integrate the **OIDC** module into your **Journey** module configuration, to obtain and manage OpenID Connect 1.0 tokens on behalf of the user.

To integrate the **OIDC** module, add the configuration when instatiating the `Journey` class as follows:

Integrating the `oidc` module with the `journey` module

```kotlin
val journey = Journey {
    serverUrl = "https://openam-forgerock-sdks.forgeblocks.com/am"
    realm = "alpha"
    cookie = "ch15fefc5407912"
    module(Oidc) {
        clientId = "sdkPublicClient"
        discoveryEndpoint = "https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/realms/alpha/.well-known/openid-configuration"
        scopes = ["openid", "email", "address"]
        redirectUri = "org.forgerock.demo://oauth2redirect"
    }
}
```

Update the following properties with values that match your environment:

* *clientId*

  The client ID from your OAuth 2.0 application.

  For example, `sdkPublicClient`

* *discoveryEndpoint*

  The `.well-known` endpoint from your server.

  > **Collapse: How do I find my PingOne Advanced Identity Cloud  URL?**
  >
  > You can view the `.well-known` endpoint for an OAuth 2.0 client in the PingOne Advanced Identity Cloud admin console:
  >
  > 1. Log in to your PingOne Advanced Identity Cloud administration console.
  >
  > 2. Click Applications, and then select the OAuth 2.0 client you created earlier. For example, sdkPublicClient.
  >
  > 3. On the Sign On tab, in the Client Credentials section, copy the Discovery URI value.
  >
  >    For example, `https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/alpha/.well-known/openid-configuration`
  >
  > |   |                                                                                                                                                                                                                                                                                                                                 |
  > | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  > |   | If you are using a custom domain, your `.well-known` is formed as follows:`https://<custom-domain-fqdn>/.well-known/openid-configuration`Learn more in [Access OIDC configuration discovery endpoint](https://docs.pingidentity.com/pingoneaic/latest/realms/custom-domains.html#access-oidc-configuration-discovery-endpoint). |

  > **Collapse: How do I find my PingAM  URL?**
  >
  > To form the `.well-known` URL for an PingAM server, concatenate the following information into a single URL:
  >
  > 1. The base URL of the PingAM component of your deployment, including the port number and deployment path.
  >
  >    For example, `https://openam.example.com:8443/openam`
  >
  > 2. The string `/oauth2`
  >
  > 3. The hierarchy of the realm that contains the OAuth 2.0 client.
  >
  >    You must specify the entire hierarchy of the realm, starting at the Top Level Realm. Prefix each realm in the hierarchy with the `realms/` keyword.
  >
  >    For example, `/realms/root/realms/customers`
  >
  >    |   |                                                                                 |
  >    | - | ------------------------------------------------------------------------------- |
  >    |   | If you omit the realm hierarchy, the top level `ROOT` realm is used by default. |
  >
  > 4. The string `/.well-known/openid-configuration`
  >
  > For example, `https://openam.example.com:8443/openam/oauth2/realms/root/.well-known/openid-configuration`

  For example, `https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/realms/alpha/.well-known/openid-configuration`

* *scopes*

  The scopes you added to your OAuth 2.0 application.

  For example, `"openid", "email", "address", "profile", "phone"`

* *redirectUri*

  The `redirect_uri` as configured in the OAuth 2.0 client profile.

  This value must exactly match a value configured in your OAuth 2.0 client.

  For example, `com.example.demo://oauth2redirect`
