Function login

login(
    client: Client,
    parameters: { password?: string; username?: string },
    options?: RequestOptions,
): Promise<
    {
        loginInfo?: {
            failedLoginCount?: number;
            lastFailedLoginTime?: Date;
            loginCount?: number;
            previousLoginTime?: Date;
            [key: string]: unknown;
        };
        session?: { name?: string; value?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
Creates a new session for a user in Jira. Once a session has been successfully created it can be used to access any of Jira's remote APIs and also the web UI by passing the appropriate HTTP Cookie header. Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource may be used to mimic the behaviour of Jira's log-in page (e.g. to display log-in errors to a user).
Parameters
- client: Client
- parameters: { password?: string; username?: string }
- Optionaloptions: RequestOptions
Returns Promise<
    {
        loginInfo?: {
            failedLoginCount?: number;
            lastFailedLoginTime?: Date;
            loginCount?: number;
            previousLoginTime?: Date;
            [key: string]: unknown;
        };
        session?: { name?: string; value?: string; [key: string]: unknown };
        [key: string]: unknown;
    },
>
- Defined in src/server/api/session.ts:27