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

UserApi

class UserApi(api: ApiClient) : Api

Constructors

UserApi

constructor(api: ApiClient)

Functions

authenticateUserByName

suspend fun authenticateUserByName(data: AuthenticateUserByName): Response<AuthenticationResult>

Authenticates a user by name.

authenticateUserByName

inline suspend fun UserApi.authenticateUserByName(username: String, password: String): Response<AuthenticationResult>

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

authenticateWithQuickConnect

suspend fun authenticateWithQuickConnect(data: QuickConnectDto): Response<AuthenticationResult>

Authenticates a user with quick connect.

authenticateWithQuickConnect

inline suspend fun UserApi.authenticateWithQuickConnect(secret: String): Response<AuthenticationResult>

Extension function for the authenticateWithQuickConnect operation that accepts the secret directly

createUserByName

suspend fun createUserByName(data: CreateUserByName): Response<UserDto>

Creates a user.

deleteUser

suspend fun deleteUser(userId: UUID): Response<Unit>

Deletes a user.

forgotPassword

suspend fun forgotPassword(data: ForgotPasswordDto): Response<ForgotPasswordResult>

Initiates the forgot password process for a local user.

forgotPasswordPin

suspend fun forgotPasswordPin(data: ForgotPasswordPinDto): Response<PinRedeemResult>

Redeems a forgot password pin.

getCurrentUser

suspend fun getCurrentUser(): Response<UserDto>

Gets the user based on auth token.

getPublicUsers

suspend fun getPublicUsers(): Response<List<UserDto>>

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

getUserById

suspend fun getUserById(userId: UUID): Response<UserDto>

Gets a user by Id.

getUsers

suspend fun getUsers(isHidden: Boolean? = null, isDisabled: Boolean? = null): Response<List<UserDto>>

Gets a list of users.

updateUser

suspend fun updateUser(userId: UUID? = null, data: UserDto): Response<Unit>

Updates a user.

updateUserConfiguration

suspend fun updateUserConfiguration(userId: UUID? = null, data: UserConfiguration): Response<Unit>

Updates a user configuration.

updateUserPassword

suspend fun updateUserPassword(userId: UUID? = null, data: UpdateUserPassword): Response<Unit>

Updates a user's password.

updateUserPolicy

suspend fun updateUserPolicy(userId: UUID, data: UserPolicy): Response<Unit>

Updates a user policy.