@inrupt/solid-client-authn-browser
    Preparing search index...

    Interface ILoginInputOptions

    interface ILoginInputOptions {
        clientId?: string;
        clientName?: string;
        clientSecret?: string;
        customScopes?: string[];
        handleRedirect?: (redirectUrl: string) => unknown;
        oidcIssuer?: string;
        redirectUrl?: string;
        refreshToken?: string;
        tokenType?: "DPoP" | "Bearer";
    }
    Index

    Properties

    clientId? clientName? clientSecret? customScopes? handleRedirect? oidcIssuer? redirectUrl? refreshToken? tokenType?

    Properties

    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.

    clientName?: string

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

    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.

    customScopes?: string[]

    Custom scopes that will be sent to the OpenID Provider to request access to additional claims in the ID Token. These scopes are added to the default scopes supported by the library (webid, openid, offline_access).

    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.

    oidcIssuer?: string

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

    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.

    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.

    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.

    Settings

    Member Visibility

    On This Page

    Properties