Function UserApiAxiosParamCreator

Returns {
    authenticateUserByName: ((authenticateUserByName: AuthenticateUserByName, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    authenticateWithQuickConnect: ((quickConnectDto: QuickConnectDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    createUserByName: ((createUserByName: CreateUserByName, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    deleteUser: ((userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    forgotPassword: ((forgotPasswordDto: ForgotPasswordDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    forgotPasswordPin: ((forgotPasswordPinDto: ForgotPasswordPinDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getCurrentUser: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPublicUsers: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getUserById: ((userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getUsers: ((isHidden?: boolean, isDisabled?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateUser: ((userDto: UserDto, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateUserConfiguration: ((userConfiguration: UserConfiguration, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateUserPassword: ((updateUserPassword: UpdateUserPassword, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updateUserPolicy: ((userId: string, userPolicy: UserPolicy, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• authenticateUserByName: ((authenticateUserByName: AuthenticateUserByName, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Authenticates a user by name.

  Throws

  • • (authenticateUserByName, options?): Promise<RequestArgs>

    • Parameters

      • authenticateUserByName: AuthenticateUserByName

        The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• authenticateWithQuickConnect: ((quickConnectDto: QuickConnectDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Authenticates a user with quick connect.

  Throws

  • • (quickConnectDto, options?): Promise<RequestArgs>

    • Parameters

      • quickConnectDto: QuickConnectDto

        The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createUserByName: ((createUserByName: CreateUserByName, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Creates a user.

  Throws

  • • (createUserByName, options?): Promise<RequestArgs>

    • Parameters

      • createUserByName: CreateUserByName

        The create user by name request body.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteUser: ((userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Deletes a user.

  Throws

  • • (userId, options?): Promise<RequestArgs>

    • Parameters

      • userId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• forgotPassword: ((forgotPasswordDto: ForgotPasswordDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Initiates the forgot password process for a local user.

  Throws

  • • (forgotPasswordDto, options?): Promise<RequestArgs>

    • Parameters

      • forgotPasswordDto: ForgotPasswordDto

        The forgot password request containing the entered username.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• forgotPasswordPin: ((forgotPasswordPinDto: ForgotPasswordPinDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Redeems a forgot password pin.

  Throws

  • • (forgotPasswordPinDto, options?): Promise<RequestArgs>

    • Parameters

      • forgotPasswordPinDto: ForgotPasswordPinDto

        The forgot password pin request containing the entered pin.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getCurrentUser: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets the user based on auth token.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPublicUsers: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a list of publicly visible users for display on a login screen.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getUserById: ((userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a user by Id.

  Throws

  • • (userId, options?): Promise<RequestArgs>

    • Parameters

      • userId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getUsers: ((isHidden?: boolean, isDisabled?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a list of users.

  Throws

  • • (isHidden?, isDisabled?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalisHidden: boolean

        Optional filter by IsHidden=true or false.
      • OptionalisDisabled: boolean

        Optional filter by IsDisabled=true or false.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateUser: ((userDto: UserDto, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a user.

  Throws

  • • (userDto, userId?, options?): Promise<RequestArgs>

    • Parameters

      • userDto: UserDto

        The updated user model.
      • OptionaluserId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateUserConfiguration: ((userConfiguration: UserConfiguration, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a user configuration.

  Throws

  • • (userConfiguration, userId?, options?): Promise<RequestArgs>

    • Parameters

      • userConfiguration: UserConfiguration

        The new user configuration.
      • OptionaluserId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateUserPassword: ((updateUserPassword: UpdateUserPassword, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a user's password.

  Throws

  • • (updateUserPassword, userId?, options?): Promise<RequestArgs>

    • Parameters

      • updateUserPassword: UpdateUserPassword

        The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Nullable{System.Guid},Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request.
      • OptionaluserId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updateUserPolicy: ((userId: string, userPolicy: UserPolicy, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a user policy.

  Throws

  • • (userId, userPolicy, options?): Promise<RequestArgs>

    • Parameters

      • userId: string

        The user id.
      • userPolicy: UserPolicy

        The new user policy.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>