Chartbreaker
    Preparing search index...

    Interface LoginDescriptor

    Describes how to obtain a SessionToken.

    interface LoginDescriptor {
        envHint?: string;
        envs: LoginOptions;
        form?: LoginForm;
        obtainSessionToken?(
            param0: {
                clientLoginData?: string;
                env?: string;
                eventContext?: any;
                oauthFragment?: string;
                redirectForOAuthLogin?: RedirectForOAuthLogin;
                values?: { password?: string; username?: string };
            },
        ): Promise<
            {
                completeLoginOperation?: AuthorizedOperation<void>;
                sessionToken: string;
            },
        >;
    }
    Index

    Properties

    envHint? envs form?

    Methods

    obtainSessionToken?

    Properties

    envHint?: string

    If this is set, there is an explanation text for the environment selection which should be presented to the user (i.e. it explains what can be chosen here).

    envs: LoginOptions

    A list of environments to choose from. Mostly required for choosing between test environments and production during development.

    form?: LoginForm

    If form is present, the defined fields are required for login.

    Methods

    • Prepare a session by obtaining a token (e.g. a SessionId). This may involve an OAuth flow, but can also simply be a login request which returns the broker's sessionId.

      If the response contains a completeLoginOperation, this means that the authorized operation needs to be used to complete the login.

      Parameters

      • param0: {
            clientLoginData?: string;
            env?: string;
            eventContext?: any;
            oauthFragment?: string;
            redirectForOAuthLogin?: RedirectForOAuthLogin;
            values?: { password?: string; username?: string };
        }

      Returns Promise<
          {
              completeLoginOperation?: AuthorizedOperation<void>;
              sessionToken: string;
          },
      >

    Settings

    Member Visibility

    On This Page

    Properties
    Methods