Interface ClientOpts

Client options to manually configure a client.

Hierarchy

  • BaseClientOpts
    • ClientOpts

Properties

authorizationOpts: Partial<BaseAuthorizationCodeParams>
authorization_endpoint: string

The URL used to request an authorization code.

cache_type?: "memory" | "local_storage" | "session_storage"

Defines where cache data is stored, possible values are: memory, local_storage or session_storage. Default: 'memory'

client_id: string

OAuth2 client identifier of your application.

issuer: string

The expected issuer of the tokens.

logout_endpoint: string

the URL used to request a logout.

signup_endpoint?: string

the URL used to signup a new user

state_type?: "local_storage" | "session_storage"

Defines where cache data is stored, possible values local_storage or session_storage. In most cases session_storage is sufficient but local_storage is required in cases where your auth flow spread in multiple tabs (e.g., "activation by email link is opened within another tab) Default: 'session_storage'

template_id?: string

The template ID to display in the login/consent flow

token_endpoint: string

The URL used to exchange an authorization code with tokens.

ui_locales?: string

Defines the default locales to request for the login/consent ui