jellyfin-api/org.jellyfin.sdk.api.operations/UserApi

UserApi

class UserApi(api: ApiClient) : Api

Constructors

Link copied to clipboard
constructor(api: ApiClient)

Functions

Link copied to clipboard
suspend fun authenticateUserByName(data: <Error class: unknown class>): Response<<Error class: unknown class>>

Authenticates a user by name.

Link copied to clipboard
inline suspend fun UserApi.authenticateUserByName(username: String, password: String): Response<<Error class: unknown class>>

Extension function for the authenticateUserByName operation that accepts the username and password directly

Link copied to clipboard
suspend fun authenticateWithQuickConnect(data: <Error class: unknown class>): Response<<Error class: unknown class>>

Authenticates a user with quick connect.

Link copied to clipboard
inline suspend fun UserApi.authenticateWithQuickConnect(secret: String): Response<<Error class: unknown class>>

Extension function for the authenticateWithQuickConnect operation that accepts the secret directly

Link copied to clipboard
suspend fun createUserByName(data: <Error class: unknown class>): Response<<Error class: unknown class>>

Creates a user.

Link copied to clipboard
suspend fun deleteUser(userId: <Error class: unknown class>): Response<Unit>

Deletes a user.

Link copied to clipboard
suspend fun forgotPassword(data: <Error class: unknown class>): Response<<Error class: unknown class>>

Initiates the forgot password process for a local user.

Link copied to clipboard
suspend fun forgotPasswordPin(data: <Error class: unknown class>): Response<<Error class: unknown class>>

Redeems a forgot password pin.

Link copied to clipboard
suspend fun getCurrentUser(): Response<<Error class: unknown class>>

Gets the user based on auth token.

Link copied to clipboard
suspend fun getPublicUsers(): Response<List<<Error class: unknown class>>>

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

Link copied to clipboard
suspend fun getUserById(userId: <Error class: unknown class>): Response<<Error class: unknown class>>

Gets a user by Id.

Link copied to clipboard
suspend fun getUsers(isHidden: Boolean? = null, isDisabled: Boolean? = null): Response<List<<Error class: unknown class>>>

Gets a list of users.

Link copied to clipboard
suspend fun updateUser(userId: <Error class: unknown class>? = null, data: <Error class: unknown class>): Response<Unit>

Updates a user.

Link copied to clipboard
suspend fun updateUserConfiguration(userId: <Error class: unknown class>? = null, data: <Error class: unknown class>): Response<Unit>

Updates a user configuration.

Link copied to clipboard
suspend fun updateUserPassword(userId: <Error class: unknown class>? = null, data: <Error class: unknown class>): Response<Unit>

Updates a user's password.

Link copied to clipboard
suspend fun updateUserPolicy(userId: <Error class: unknown class>, data: <Error class: unknown class>): Response<Unit>

Updates a user policy.