Configuring a Journey client in React Native

PingOne Advanced Identity Cloud PingAM React Native

You must configure a Journey client to connect to your Advanced Identity Cloud or PingAM server.

To configure a client, call the createJourneyClient() factory function and provide the configuration options as follows:

Configuring the createJourneyClient factory

import { createJourneyClient } from '@ping-identity/rn-journey';
import { logger } from '@ping-identity/rn-logger';

// Optionally, set the log level to 'debug'
const debugLogger = logger({ level: 'debug' });

const journeyClient = createJourneyClient({
  serverUrl: 'https://openam-forgerock-sdks.forgeblocks.com/am',
  realm: 'alpha',
  cookie: 'ch15fefc5407912',
  timeout: 5000,
  logger: debugLogger,
});

Update the following properties with values that match your environment:

serverUrl

The URL of the Access Management service on your server. This is the only required property.

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 Advanced Identity Cloud tenants, the cookie name is a random string of characters, such as ch15fefc5407912.
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.

timeout

The maximum time, in milliseconds, that the client waits for a response from the server.

Default is 5000 (5 seconds).

logger

Optionally, specify the logger instance to use to output messages from the Orchestration SDK.

Pass the level parameter to the instance to configure the amount of detail the Orchestration SDK outputs. Choose from, debug, info, warn, error, or none.

Integrating the OIDC Module

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

To integrate the oidc module, add the configuration when instantiating the journey client, as follows:

Integrating the oidc module with the journey client

import { createJourneyClient } from '@ping-identity/rn-journey';

const journeyClient = createJourneyClient({
    serverUrl: 'https://openam-forgerock-sdks.forgeblocks.com/am',
    realm: 'alpha',
    cookie: 'ch15fefc5407912',
    modules: {
        oidc: {
          clientId: 'sdkPublicClient',
          discoveryEndpoint: 'https://openam-forgerock-sdks.forgeblocks.com/am/oauth2/realms/alpha/.well-known/openid-configuration',
          scopes: ['openid', 'email', 'address', 'profile'],
          redirectUri: 'com.example.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.

How do I find my PingOne Advanced Identity Cloud .well-known URL?

You can view the .well-known endpoint for an OAuth 2.0 client in the PingOne Advanced Identity Cloud admin console:

Log in to your PingOne Advanced Identity Cloud administration console.
Click Applications, and then select the OAuth 2.0 client you created earlier. For example, sdkPublicClient.
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.

How do I find my PingAM .well-known URL?

To form the .well-known URL for an PingAM server, concatenate the following information into a single URL:

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
The string /oauth2
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.
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'

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

Orchestration SDKs

Configuring a Journey client in React Native

Integrating the OIDC Module