Type Alias: OrgConfig

OrgConfig: object

Represents the configuration needed to connect to a Salesforce org.

Multi-org Note: When using orgConfigs in AnalyticsSdkConfig, each OrgConfig represents one org. The orgUrl must be a Lightning URL (e.g., https://yourorg.lightning.force.com).

authCredential: string

Required. The credential to use for authentication. For example, a Frontdoor URL or a generated access token.

orgUrl: string

Required. The URL for the Salesforce org. Must be a Lightning URL (e.g., https://yourorg.lightning.force.com).

optional reason: string

The reason for this org authentication state. For example, why did authentication fail. Contains error details when initialization or logout fails. Set by the SDK in response objects.

optional redirectOrigin: string

The origin extracted from redirectUrl (only present when redirectUrl is provided). Set by the SDK in response objects.

optional redirectUrl: string

The redirect URL for authentication (only present when state is AUTH_REDIRECT). Set by the SDK in response objects.

optional state: OrgStates | ErrorCode | string

The org status. This is represented as either a OrgStates or ErrorCode enum value. Indicates the current state of the org (e.g., OrgStates.INITIALIZATION_SUCCESS, OrgStates.INITIALIZATION_ERROR, OrgStates.LOGGED_OUT). Set by the SDK in response objects.