UsersApi

interface UsersApi
Content copied to clipboard

Functions

createUser
Link copied to clipboard
@POST(value = users)
abstract suspend fun createUser(@Body() userRequestDto: UserRequestDto): Response<RegisterUserResponseDto>
Content copied to clipboard
Register a user This API call allows you to register a new user.
deleteUser
Link copied to clipboard
@DELETE(value = users/{userID})
abstract suspend fun deleteUser(@Path(value = userID) userID: String, @Query(value = export) export: Boolean? = null, @Query(value = exportEmail) exportEmail: String? = null): Response<EmptyObjectResponseDto>
Content copied to clipboard
Delete user account This allows you to delete a user account.
getEmailAvailability
Link copied to clipboard
@GET(value = users/emailAvailability)
abstract suspend fun getEmailAvailability(@Query(value = email) email: String): Response<EmailAvailabilityResponseDto>
Content copied to clipboard
Check for the availability of an email address to register a new user.
getUserById
Link copied to clipboard
@GET(value = users/{userID})
abstract suspend fun getUserById(@Path(value = userID) userID: String, @Query(value = excludeAlerts) excludeAlerts: Boolean? = null): Response<UserResponseDto>
Content copied to clipboard
Retrieve account information This allows you to retrieve the account information for a user.
getUsernameAvailability
Link copied to clipboard
@GET(value = users/usernameAvailability)
abstract suspend fun getUsernameAvailability(@Query(value = username) username: String, @Query(value = credentialType) credentialType: String? = null): Response<UsernameAvailabilityResponseDto>
Content copied to clipboard
Check for the availability of a username.
registerWithJwt
Link copied to clipboard
@POST(value = jwtRegister)
abstract suspend fun registerWithJwt(@Body() jwtUserRequestDto: JwtUserRequestDto): Response<RegisterUserResponseDto>
Content copied to clipboard
Register a user using JWT This API call allows you to register a new user using a JSON Web Token.
upsertUser
Link copied to clipboard
@PUT(value = users/{userID})
abstract suspend fun upsertUser(@Path(value = userID) userID: String, @Body() body: UserUpdateDtoProperties): Response<EmptyObjectResponseDto>
Content copied to clipboard
Update account information This allows you to update the account information of a user.