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

AuthenticationApi

class AuthenticationApi(api: ApiClient) : Api

Constructors

AuthenticationApi

constructor(api: ApiClient)

Functions

authenticateUserByName

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

Authenticates a user by name.

authenticateUserByName

inline suspend fun AuthenticationApi.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 AuthenticationApi.authenticateWithQuickConnect(secret: String): Response<AuthenticationResult>

Extension function for the authenticateWithQuickConnect operation that accepts the secret directly

authorizeQuickConnect

suspend fun authorizeQuickConnect(code: String, userId: UUID? = null): Response<Boolean>

Authorizes a pending quick connect request.

createKey

suspend fun createKey(app: String): Response<Unit>

Create a new api key.

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.

getAuthProviders

suspend fun getAuthProviders(): Response<List<NameIdPair>>

Get all auth providers.

getKeys

suspend fun getKeys(): Response<AuthenticationInfoQueryResult>

Get all keys.

getPasswordResetProviders

suspend fun getPasswordResetProviders(): Response<List<NameIdPair>>

Get all password reset providers.

getQuickConnectEnabled

suspend fun getQuickConnectEnabled(): Response<Boolean>

Gets the current quick connect state.

getQuickConnectState

suspend fun getQuickConnectState(secret: String): Response<QuickConnectResult>

Attempts to retrieve authentication information.

initiateQuickConnect

suspend fun initiateQuickConnect(): Response<QuickConnectResult>

Initiate a new quick connect request.

revokeKey

suspend fun revokeKey(key: String): Response<Unit>

Remove an api key.