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: Symbol not found for AuthenticateUserByName): Response<ERROR CLASS: Symbol not found for AuthenticationResult>

Authenticates a user by name.

Link copied to clipboard
inline suspend fun UserApi.authenticateUserByName(username: String, password: String): Response<ERROR CLASS: Symbol not found for AuthenticationResult>

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

Link copied to clipboard
suspend fun authenticateWithQuickConnect(data: ERROR CLASS: Symbol not found for QuickConnectDto): Response<ERROR CLASS: Symbol not found for AuthenticationResult>

Authenticates a user with quick connect.

Link copied to clipboard
inline suspend fun UserApi.authenticateWithQuickConnect(secret: String): Response<ERROR CLASS: Symbol not found for AuthenticationResult>

Extension function for the authenticateWithQuickConnect operation that accepts the secret directly

Link copied to clipboard
suspend fun createUserByName(data: ERROR CLASS: Symbol not found for CreateUserByName): Response<ERROR CLASS: Symbol not found for UserDto>

Creates a user.

Link copied to clipboard
suspend fun deleteUser(userId: ERROR CLASS: Symbol not found for UUID): Response<Unit>

Deletes a user.

Link copied to clipboard
suspend fun forgotPassword(data: ERROR CLASS: Symbol not found for ForgotPasswordDto): Response<ERROR CLASS: Symbol not found for ForgotPasswordResult>

Initiates the forgot password process for a local user.

Link copied to clipboard
suspend fun forgotPasswordPin(data: ERROR CLASS: Symbol not found for ForgotPasswordPinDto): Response<ERROR CLASS: Symbol not found for PinRedeemResult>

Redeems a forgot password pin.

Link copied to clipboard
suspend fun getCurrentUser(): Response<ERROR CLASS: Symbol not found for UserDto>

Gets the user based on auth token.

Link copied to clipboard
suspend fun getPublicUsers(): Response<List<ERROR CLASS: Symbol not found for UserDto>>

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

Link copied to clipboard
suspend fun getUserById(userId: ERROR CLASS: Symbol not found for UUID): Response<ERROR CLASS: Symbol not found for UserDto>

Gets a user by Id.

Link copied to clipboard
suspend fun getUsers(isHidden: Boolean? = null, isDisabled: Boolean? = null): Response<List<ERROR CLASS: Symbol not found for UserDto>>

Gets a list of users.

Link copied to clipboard
suspend fun updateUser(userId: ERROR CLASS: Symbol not found for UUID?? = null, data: ERROR CLASS: Symbol not found for UserDto): Response<Unit>

Updates a user.

Link copied to clipboard
suspend fun updateUserConfiguration(userId: ERROR CLASS: Symbol not found for UUID?? = null, data: ERROR CLASS: Symbol not found for UserConfiguration): Response<Unit>

Updates a user configuration.

Link copied to clipboard
suspend fun updateUserPassword(userId: ERROR CLASS: Symbol not found for UUID?? = null, data: ERROR CLASS: Symbol not found for UpdateUserPassword): Response<Unit>

Updates a user's password.

Link copied to clipboard
suspend fun updateUserPolicy(userId: ERROR CLASS: Symbol not found for UUID, data: ERROR CLASS: Symbol not found for UserPolicy): Response<Unit>

Updates a user policy.