@inrupt/solid-client-authn-node / ILoginInputOptions
Interface: ILoginInputOptions#
Properties#
clientId#
• Optional clientId: 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#
packages/core/dist/ILoginInputOptions.d.ts:13
clientName#
• Optional clientName: string
Human-readable name for the client (as opposed to the client ID)
Defined in#
packages/core/dist/ILoginInputOptions.d.ts:21
clientSecret#
• Optional clientSecret: string
A secret associated with 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#
packages/core/dist/ILoginInputOptions.d.ts:17
handleRedirect#
• Optional handleRedirect: (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, ignored in the browser.
Type declaration#
▸ (redirectUrl): unknown
Parameters#
Name |
Type |
|---|---|
|
|
Returns#
unknown
Defined in#
packages/core/dist/ILoginInputOptions.d.ts:26
oidcIssuer#
• Optional oidcIssuer: string
The user’s identity provider, e.g. https://inrupt.net. Usually provided by the user.
Defined in#
packages/core/dist/ILoginInputOptions.d.ts:5
redirectUrl#
• Optional redirectUrl: 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#
packages/core/dist/ILoginInputOptions.d.ts:9
refreshToken#
• Optional refreshToken: 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#
packages/core/dist/ILoginInputOptions.d.ts:36
tokenType#
• Optional tokenType: "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#
packages/core/dist/ILoginInputOptions.d.ts:31