@inrupt/solid-client-authn-core / ILoginInputOptions

Interface: ILoginInputOptions

Hierarchy

  • ILoginInputOptions

Properties

clientId

Optional clientId: undefined | string

A ID for your application, previously registered to the identity provider. Only required if users of your app log in an identity provider known a priori, which only supports a predefined set of apps and prevents dynamic registration.

Defined in: src/ILoginInputOptions.ts:34


clientName

Optional clientName: undefined | string

Human-readable name for the client (as opposed to the client ID)

Defined in: src/ILoginInputOptions.ts:42


clientSecret

Optional clientSecret: undefined | string

A secret associated to your client ID during client registration to the the identity provider. Only required if users of your app log in an identity provider known a priori, which only supports a predefined set of apps and prevents dynamic registration.

Defined in: src/ILoginInputOptions.ts:38


handleRedirect

Optional handleRedirect: undefined | (redirectUrl: string) => unknown

If a function is provided, the browser will not auto-redirect and will instead trigger that function to redirect. Required in non-browser environments.

Defined in: src/ILoginInputOptions.ts:50


oidcIssuer

Optional oidcIssuer: undefined | string

The user’s identity provider, e.g. https://inrupt.net. Usually provided by the user.

Defined in: src/ILoginInputOptions.ts:26



redirectUrl

Optional redirectUrl: undefined | string

The URL within this application that the user should be redirected to after successful login. This can be either a web URL or a mobile URL scheme.

Defined in: src/ILoginInputOptions.ts:30


refreshToken

Optional refreshToken: undefined | string

If you already have a refresh token available, it may be used to log in along with the associated client ID and secret to authenticate.

Defined in: src/ILoginInputOptions.ts:60


tokenType

Optional tokenType: undefined | DPoP | Bearer

The type of access token you want to use. Using a cookie-based system requires Bearer tokens, but DPoP tokens provide an additional safety against replay. By default, a DPoP token will be used.

Defined in: src/ILoginInputOptions.ts:55