Function AuthenticationApiFp

Returns {
    authenticateUserByName(
        authenticateUserByName: AuthenticateUserByName,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationResult>,
    >;
    authenticateWithQuickConnect(
        quickConnectDto: QuickConnectDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationResult>,
    >;
    authorizeQuickConnect(
        code: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
    >;
    createKey(
        app: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    forgotPassword(
        forgotPasswordDto: ForgotPasswordDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ForgotPasswordResult>,
    >;
    forgotPasswordPin(
        forgotPasswordPinDto: ForgotPasswordPinDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PinRedeemResult>,
    >;
    getAuthProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<NameIdPair[]>,
    >;
    getKeys(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationInfoQueryResult>,
    >;
    getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<NameIdPair[]>,
    >;
    getQuickConnectEnabled(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
    >;
    getQuickConnectState(
        secret: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QuickConnectResult>,
    >;
    initiateQuickConnect(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QuickConnectResult>,
    >;
    revokeKey(
        key: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
}

• authenticateUserByName: function

  • authenticateUserByName(
        authenticateUserByName: AuthenticateUserByName,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationResult>,
    >

    Parameters

    • authenticateUserByName: AuthenticateUserByName

      The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationResult>,
    >

    Throws

• authenticateWithQuickConnect: function

  • authenticateWithQuickConnect(
        quickConnectDto: QuickConnectDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationResult>,
    >

    Parameters

    • quickConnectDto: QuickConnectDto

      The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationResult>,
    >

    Throws

• authorizeQuickConnect: function

  • authorizeQuickConnect(
        code: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
    >

    Parameters

    • code: string

      Quick connect code to authorize.

    • OptionaluserId: string

      The user the authorize. Access to the requested user is required.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>

    Throws

• createKey: function

  • createKey(
        app: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • app: string

      Name of the app using the authentication key.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• forgotPassword: function

  • forgotPassword(
        forgotPasswordDto: ForgotPasswordDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ForgotPasswordResult>,
    >

    Parameters

    • forgotPasswordDto: ForgotPasswordDto

      The forgot password request containing the entered username.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ForgotPasswordResult>,
    >

    Throws

• forgotPasswordPin: function

  • forgotPasswordPin(
        forgotPasswordPinDto: ForgotPasswordPinDto,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PinRedeemResult>,
    >

    Parameters

    • forgotPasswordPinDto: ForgotPasswordPinDto

      The forgot password pin request containing the entered pin.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PinRedeemResult>,
    >

    Throws

• getAuthProviders: function

  • getAuthProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Throws

• getKeys: function

  • getKeys(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationInfoQueryResult>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AuthenticationInfoQueryResult>,
    >

    Throws

• getPasswordResetProviders: function

  • getPasswordResetProviders(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>,
    >

    Throws

• getQuickConnectEnabled: function

  • getQuickConnectEnabled(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>

    Throws

• getQuickConnectState: function

  • getQuickConnectState(
        secret: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QuickConnectResult>,
    >

    Parameters

    • secret: string

      Secret previously returned from the Initiate endpoint.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QuickConnectResult>,
    >

    Throws

• initiateQuickConnect: function

  • initiateQuickConnect(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QuickConnectResult>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<QuickConnectResult>,
    >

    Throws

• revokeKey: function

  • revokeKey(
        key: string,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • key: string

      The access token to delete.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws