Documentation
    Preparing search index...

    Type Alias SvelteServerOptions

    SvelteServerOptions: Partial<AuthorizationCodeProviderOptions> & {
        credentials?: AuthorizationCodeProvider;
        errorRedirect?: string;
        getIdToken?: (token: AccessToken) => string;
        logIn?: string;
        logInRedirect?: string;
        logOut?: string;
        logOutRedirect?: string;
        sessionIdCookieName?: string;
        userInfoCallback?: (
            this: AuthorizationCodeProvider,
            token: AccessToken,
        ) => Promise<UserInfo>;
        userInfoCookieName?: string;
    }

    Type Declaration

    • Optionalcredentials?: AuthorizationCodeProvider

      Authorization code provider to use to configure authentication.

    • OptionalerrorRedirect?: string

      The path to redirect the caller to after an error is encountered during the authorization flow.

    • OptionalgetIdToken?: (token: AccessToken) => string

      Retrieve the ID token. The default behavior is to use the access token. Some auth providers give separate id tokens and access tokens, in which case the access tokens are not jwts.

    • OptionallogIn?: string

      The path which redirects the caller to the authorization url to sign in.

    • OptionallogInRedirect?: string

      The path to redirect the caller to after signing in.

    • OptionallogOut?: string

      The path to call to clear a user's session and revoke the access token.

    • OptionallogOutRedirect?: string

      The path to redirect the caller to after signing out.

    • OptionalsessionIdCookieName?: string

      The name of the cookie containing the session id so that AuthorizationCodeFlow can delete the session cookie when signing out.

      This must be the same as the value passed in to the @byu-oit-sdk/session-svelte constructor

    • OptionaluserInfoCallback?: (this: AuthorizationCodeProvider, token: AccessToken) => Promise<UserInfo>

      Retrieve user information for a given request. The default behavior is to decode the token. The this context of the function is bound to your provider configuration.

    • OptionaluserInfoCookieName?: string

      The name of the cookie containing the user information parsed from the token.

    Settings

    Member Visibility