@inrupt/solid-client-authn-core

Globals / “ILoginInputOptions” / ILoginInputOptions

Interface: ILoginInputOptions

Hierarchy

  • ILoginInputOptions

Properties

clientId

Optional clientId: undefined | string

Defined in ILoginInputOptions.ts:34

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.


clientName

Optional clientName: undefined | string

Defined in ILoginInputOptions.ts:42

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


clientSecret

Optional clientSecret: undefined | string

Defined in ILoginInputOptions.ts:38

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.


handleRedirect

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

Defined in ILoginInputOptions.ts:50

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


oidcIssuer

Optional oidcIssuer: undefined | string

Defined in ILoginInputOptions.ts:26

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



redirectUrl

Optional redirectUrl: undefined | string

Defined in ILoginInputOptions.ts:30

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.


tokenType

Optional tokenType: “DPoP” | “Bearer”

Defined in ILoginInputOptions.ts:55

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.