Interface ProfileConfig

Indicates whether the website is logged in with the Identity Provider (IdP). When idpProfileToken is provided, active defaults to true. Set to false to log out, or true to log in without a token.

Extra data from the Identity Provider (IdP) to enrich the header.

IdP profile token received from the ACM IdP authentication token (claim: papi_token). When provided alongside active: true, the header will use this token to fetch profile data from the ACM API and populate the idpData field. This eliminates the need to manually provide idpData when the token is available.

Prerequisite: The papi_token claim is only available for clients that have the papi scope explicitly configured. This scope must be requested and approved as part of your integration dossier before you can use this feature.

Important: idpProfileToken and active: true must be provided together in the same setProfile call. Providing them in separate calls will cause validation to fail, and the token will not be used. This token must be sent along with active: true every time you want to log in.

The URL where the sign-in button points to when clicked.

The URL where the sign-out button points to.

The URL where the 'switch capacity' link points to.

When a plain string is provided, the widget appends login_hint as a query parameter when available, and uses the same URL without it otherwise.

Alternatively, pass a SwitchCapacityUrlConfig object to provide separate URLs for targeted switching (with loginHint) and IdP-based selection (without loginHint).