Function journey

journey<ActionType extends ActionTypes = ActionTypes>(
    options: {
        config: JourneyClientConfig;
        logger?: { custom?: CustomLogger; level: LogLevel };
        requestMiddleware?: RequestMiddleware<ActionType>[];
    },
): Promise<JourneyClient>
Creates a journey client for AM authentication tree/journey interactions.

Journey-client is designed specifically for ForgeRock Access Management (AM) servers. It uses AM-proprietary endpoints for callback-based authentication trees.
Type Parameters
- ActionType extends ActionTypes = ActionTypes
Parameters
- options: {
      config: JourneyClientConfig;
      logger?: { custom?: CustomLogger; level: LogLevel };
      requestMiddleware?: RequestMiddleware<ActionType>[];
  }
  Configuration options for the journey client
  - config: JourneyClientConfig
    Configuration options (see JourneyClientConfig); only serverConfig.wellknown is required
  - Optionallogger?: { custom?: CustomLogger; level: LogLevel }
    Optional logger configuration
  - OptionalrequestMiddleware?: RequestMiddleware<ActionType>[]
    Optional middleware for request customization
Returns Promise<JourneyClient>
A journey client instance
Throws
When the wellknown URL is invalid, the fetch fails, or the response indicates a non-AM server
Example
```
try {
  const client = await journey({
    config: {
      serverConfig: {
        wellknown: 'https://am.example.com/am/oauth2/alpha/.well-known/openid-configuration',
      },
    },
  });
  const step = await client.start({ journey: 'Login' });
} catch (error) {
  console.error('Failed to initialize:', error.message);
}
```
- Defined in journey-client/src/lib/client.store.ts:75

Function journey

Type Parameters

Parameters

config: JourneyClientConfig

`Optional`logger?: { custom?: CustomLogger; level: LogLevel }

`Optional`requestMiddleware?: RequestMiddleware<ActionType>[]

Returns Promise<JourneyClient>

Throws

Example

Settings

Function journey

Type Parameters

Parameters

config: JourneyClientConfig

Optionallogger?: { custom?: CustomLogger; level: LogLevel }

OptionalrequestMiddleware?: RequestMiddleware<ActionType>[]

Returns Promise<JourneyClient>

Throws

Example

Settings

`Optional`logger?: { custom?: CustomLogger; level: LogLevel }

`Optional`requestMiddleware?: RequestMiddleware<ActionType>[]