Safe Haskell | None |
---|---|
Language | Haskell2010 |
Vikunja.API.User
Contents
- Operations
- User
- userConfirmPost
- userDeletionCancelPost
- userDeletionConfirmPost
- userDeletionRequestPost
- userExportDownloadPost
- userExportRequestPost
- userGet
- userPasswordPost
- userPasswordResetPost
- userPasswordTokenPost
- userSettingsAvatarGet
- userSettingsAvatarPost
- userSettingsAvatarUploadPut
- userSettingsEmailPost
- userSettingsGeneralPost
- userSettingsTokenCaldavGet
- userSettingsTokenCaldavIdGet
- userSettingsTokenCaldavPut
- userSettingsTotpDisablePost
- userSettingsTotpEnablePost
- userSettingsTotpEnrollPost
- userSettingsTotpGet
- userSettingsTotpQrcodeGet
- userTimezonesGet
- userTokenPost
- usernameAvatarGet
- usersGet
- User
Description
Synopsis
- userConfirmPost :: (Consumes UserConfirmPost MimeJSON, MimeRender MimeJSON UserEmailConfirm) => UserEmailConfirm -> VikunjaRequest UserConfirmPost MimeJSON ModelsMessage MimeJSON
- data UserConfirmPost
- userDeletionCancelPost :: (Consumes UserDeletionCancelPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) => V1UserPasswordConfirmation -> VikunjaRequest UserDeletionCancelPost MimeJSON ModelsMessage MimeJSON
- data UserDeletionCancelPost
- userDeletionConfirmPost :: (Consumes UserDeletionConfirmPost MimeJSON, MimeRender MimeJSON V1UserDeletionRequestConfirm) => V1UserDeletionRequestConfirm -> VikunjaRequest UserDeletionConfirmPost MimeJSON ModelsMessage MimeJSON
- data UserDeletionConfirmPost
- userDeletionRequestPost :: (Consumes UserDeletionRequestPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) => V1UserPasswordConfirmation -> VikunjaRequest UserDeletionRequestPost MimeJSON ModelsMessage MimeJSON
- data UserDeletionRequestPost
- userExportDownloadPost :: (Consumes UserExportDownloadPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) => V1UserPasswordConfirmation -> VikunjaRequest UserExportDownloadPost MimeJSON ModelsMessage MimeJSON
- data UserExportDownloadPost
- userExportRequestPost :: (Consumes UserExportRequestPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) => V1UserPasswordConfirmation -> VikunjaRequest UserExportRequestPost MimeJSON ModelsMessage MimeJSON
- data UserExportRequestPost
- userGet :: VikunjaRequest UserGet MimeNoContent V1UserWithSettings MimeJSON
- data UserGet
- userPasswordPost :: (Consumes UserPasswordPost MimeJSON, MimeRender MimeJSON V1UserPassword) => V1UserPassword -> VikunjaRequest UserPasswordPost MimeJSON ModelsMessage MimeJSON
- data UserPasswordPost
- userPasswordResetPost :: (Consumes UserPasswordResetPost MimeJSON, MimeRender MimeJSON UserPasswordReset) => UserPasswordReset -> VikunjaRequest UserPasswordResetPost MimeJSON ModelsMessage MimeJSON
- data UserPasswordResetPost
- userPasswordTokenPost :: (Consumes UserPasswordTokenPost MimeJSON, MimeRender MimeJSON UserPasswordTokenRequest) => UserPasswordTokenRequest -> VikunjaRequest UserPasswordTokenPost MimeJSON ModelsMessage MimeJSON
- data UserPasswordTokenPost
- userSettingsAvatarGet :: VikunjaRequest UserSettingsAvatarGet MimeNoContent V1UserAvatarProvider MimeJSON
- data UserSettingsAvatarGet
- userSettingsAvatarPost :: (Consumes UserSettingsAvatarPost MimeJSON, MimeRender MimeJSON V1UserAvatarProvider) => V1UserAvatarProvider -> VikunjaRequest UserSettingsAvatarPost MimeJSON ModelsMessage MimeJSON
- data UserSettingsAvatarPost
- userSettingsAvatarUploadPut :: Consumes UserSettingsAvatarUploadPut MimeMultipartFormData => Avatar -> VikunjaRequest UserSettingsAvatarUploadPut MimeMultipartFormData ModelsMessage MimeJSON
- data UserSettingsAvatarUploadPut
- userSettingsEmailPost :: (Consumes UserSettingsEmailPost MimeJSON, MimeRender MimeJSON UserEmailUpdate) => UserEmailUpdate -> VikunjaRequest UserSettingsEmailPost MimeJSON ModelsMessage MimeJSON
- data UserSettingsEmailPost
- userSettingsGeneralPost :: (Consumes UserSettingsGeneralPost MimeJSON, MimeRender MimeJSON V1UserSettings) => V1UserSettings -> VikunjaRequest UserSettingsGeneralPost MimeJSON ModelsMessage MimeJSON
- data UserSettingsGeneralPost
- userSettingsTokenCaldavGet :: VikunjaRequest UserSettingsTokenCaldavGet MimeNoContent [UserToken] MimeJSON
- data UserSettingsTokenCaldavGet
- userSettingsTokenCaldavIdGet :: Id -> VikunjaRequest UserSettingsTokenCaldavIdGet MimeNoContent ModelsMessage MimeJSON
- data UserSettingsTokenCaldavIdGet
- userSettingsTokenCaldavPut :: VikunjaRequest UserSettingsTokenCaldavPut MimeNoContent UserToken MimeJSON
- data UserSettingsTokenCaldavPut
- userSettingsTotpDisablePost :: (Consumes UserSettingsTotpDisablePost MimeJSON, MimeRender MimeJSON UserLogin) => UserLogin -> VikunjaRequest UserSettingsTotpDisablePost MimeJSON ModelsMessage MimeJSON
- data UserSettingsTotpDisablePost
- userSettingsTotpEnablePost :: (Consumes UserSettingsTotpEnablePost MimeJSON, MimeRender MimeJSON UserTOTPPasscode) => UserTOTPPasscode -> VikunjaRequest UserSettingsTotpEnablePost MimeJSON ModelsMessage MimeJSON
- data UserSettingsTotpEnablePost
- userSettingsTotpEnrollPost :: VikunjaRequest UserSettingsTotpEnrollPost MimeNoContent UserTOTP MimeJSON
- data UserSettingsTotpEnrollPost
- userSettingsTotpGet :: VikunjaRequest UserSettingsTotpGet MimeNoContent UserTOTP MimeJSON
- data UserSettingsTotpGet
- userSettingsTotpQrcodeGet :: VikunjaRequest UserSettingsTotpQrcodeGet MimeNoContent FilePath MimeJSON
- data UserSettingsTotpQrcodeGet
- userTimezonesGet :: VikunjaRequest UserTimezonesGet MimeNoContent [Text] MimeJSON
- data UserTimezonesGet
- userTokenPost :: VikunjaRequest UserTokenPost MimeNoContent AuthToken MimeJSON
- data UserTokenPost
- usernameAvatarGet :: Username -> VikunjaRequest UsernameAvatarGet MimeNoContent FilePath MimeOctetStream
- data UsernameAvatarGet
- usersGet :: VikunjaRequest UsersGet MimeNoContent [UserUser] MimeJSON
- data UsersGet
Operations
User
userConfirmPost
Arguments
:: (Consumes UserConfirmPost MimeJSON, MimeRender MimeJSON UserEmailConfirm) | |
=> UserEmailConfirm | "credentials" - The token. |
-> VikunjaRequest UserConfirmPost MimeJSON ModelsMessage MimeJSON |
POST /user/confirm
Confirm the email of a new user
Confirms the email of a newly registered user.
data UserConfirmPost Source #
Instances
Produces UserConfirmPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserConfirmPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserConfirmPost UserEmailConfirm Source # | Body Param "credentials" - The token. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserConfirmPost contentType, MimeRender contentType UserEmailConfirm) => VikunjaRequest UserConfirmPost contentType res accept -> UserEmailConfirm -> VikunjaRequest UserConfirmPost contentType res accept Source # |
userDeletionCancelPost
userDeletionCancelPost Source #
Arguments
:: (Consumes UserDeletionCancelPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) | |
=> V1UserPasswordConfirmation | "credentials" - The user password to confirm. |
-> VikunjaRequest UserDeletionCancelPost MimeJSON ModelsMessage MimeJSON |
POST /user/deletion/cancel
Abort a user deletion request
Aborts an in-progress user deletion.
data UserDeletionCancelPost Source #
Instances
Produces UserDeletionCancelPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserDeletionCancelPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserDeletionCancelPost V1UserPasswordConfirmation Source # | Body Param "credentials" - The user password to confirm. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserDeletionCancelPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserDeletionCancelPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserDeletionCancelPost contentType res accept Source # |
userDeletionConfirmPost
userDeletionConfirmPost Source #
Arguments
:: (Consumes UserDeletionConfirmPost MimeJSON, MimeRender MimeJSON V1UserDeletionRequestConfirm) | |
=> V1UserDeletionRequestConfirm | "credentials" - The token. |
-> VikunjaRequest UserDeletionConfirmPost MimeJSON ModelsMessage MimeJSON |
POST /user/deletion/confirm
Confirm a user deletion request
Confirms the deletion request of a user sent via email.
data UserDeletionConfirmPost Source #
Instances
Produces UserDeletionConfirmPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserDeletionConfirmPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserDeletionConfirmPost V1UserDeletionRequestConfirm Source # | Body Param "credentials" - The token. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserDeletionConfirmPost contentType, MimeRender contentType V1UserDeletionRequestConfirm) => VikunjaRequest UserDeletionConfirmPost contentType res accept -> V1UserDeletionRequestConfirm -> VikunjaRequest UserDeletionConfirmPost contentType res accept Source # |
userDeletionRequestPost
userDeletionRequestPost Source #
Arguments
:: (Consumes UserDeletionRequestPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) | |
=> V1UserPasswordConfirmation | "credentials" - The user password. |
-> VikunjaRequest UserDeletionRequestPost MimeJSON ModelsMessage MimeJSON |
POST /user/deletion/request
Request the deletion of the user
Requests the deletion of the current user. It will trigger an email which has to be confirmed to start the deletion.
data UserDeletionRequestPost Source #
Instances
Produces UserDeletionRequestPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserDeletionRequestPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserDeletionRequestPost V1UserPasswordConfirmation Source # | Body Param "credentials" - The user password. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserDeletionRequestPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserDeletionRequestPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserDeletionRequestPost contentType res accept Source # |
userExportDownloadPost
userExportDownloadPost Source #
Arguments
:: (Consumes UserExportDownloadPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) | |
=> V1UserPasswordConfirmation | "password" - User password to confirm the download. |
-> VikunjaRequest UserExportDownloadPost MimeJSON ModelsMessage MimeJSON |
data UserExportDownloadPost Source #
Instances
Produces UserExportDownloadPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserExportDownloadPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserExportDownloadPost V1UserPasswordConfirmation Source # | Body Param "password" - User password to confirm the download. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserExportDownloadPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserExportDownloadPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserExportDownloadPost contentType res accept Source # |
userExportRequestPost
userExportRequestPost Source #
Arguments
:: (Consumes UserExportRequestPost MimeJSON, MimeRender MimeJSON V1UserPasswordConfirmation) | |
=> V1UserPasswordConfirmation | "password" - User password to confirm the data export request. |
-> VikunjaRequest UserExportRequestPost MimeJSON ModelsMessage MimeJSON |
data UserExportRequestPost Source #
Instances
Produces UserExportRequestPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserExportRequestPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserExportRequestPost V1UserPasswordConfirmation Source # | Body Param "password" - User password to confirm the data export request. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserExportRequestPost contentType, MimeRender contentType V1UserPasswordConfirmation) => VikunjaRequest UserExportRequestPost contentType res accept -> V1UserPasswordConfirmation -> VikunjaRequest UserExportRequestPost contentType res accept Source # |
userGet
userGet :: VikunjaRequest UserGet MimeNoContent V1UserWithSettings MimeJSON Source #
GET /user
Get user information
Returns the current user object with their settings.
AuthMethod: AuthApiKeyJWTKeyAuth
userPasswordPost
Arguments
:: (Consumes UserPasswordPost MimeJSON, MimeRender MimeJSON V1UserPassword) | |
=> V1UserPassword | "userPassword" - The current and new password. |
-> VikunjaRequest UserPasswordPost MimeJSON ModelsMessage MimeJSON |
POST /user/password
Change password
Lets the current user change its password.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserPasswordPost Source #
Instances
Produces UserPasswordPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserPasswordPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserPasswordPost V1UserPassword Source # | Body Param "userPassword" - The current and new password. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserPasswordPost contentType, MimeRender contentType V1UserPassword) => VikunjaRequest UserPasswordPost contentType res accept -> V1UserPassword -> VikunjaRequest UserPasswordPost contentType res accept Source # |
userPasswordResetPost
userPasswordResetPost Source #
Arguments
:: (Consumes UserPasswordResetPost MimeJSON, MimeRender MimeJSON UserPasswordReset) | |
=> UserPasswordReset | "credentials" - The token with the new password. |
-> VikunjaRequest UserPasswordResetPost MimeJSON ModelsMessage MimeJSON |
POST /user/password/reset
Resets a password
Resets a user email with a previously reset token.
data UserPasswordResetPost Source #
Instances
Produces UserPasswordResetPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserPasswordResetPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserPasswordResetPost UserPasswordReset Source # | Body Param "credentials" - The token with the new password. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserPasswordResetPost contentType, MimeRender contentType UserPasswordReset) => VikunjaRequest UserPasswordResetPost contentType res accept -> UserPasswordReset -> VikunjaRequest UserPasswordResetPost contentType res accept Source # |
userPasswordTokenPost
userPasswordTokenPost Source #
Arguments
:: (Consumes UserPasswordTokenPost MimeJSON, MimeRender MimeJSON UserPasswordTokenRequest) | |
=> UserPasswordTokenRequest | "credentials" - The username of the user to request a token for. |
-> VikunjaRequest UserPasswordTokenPost MimeJSON ModelsMessage MimeJSON |
POST /user/password/token
Request password reset token
Requests a token to reset a users password. The token is sent via email.
data UserPasswordTokenPost Source #
Instances
Produces UserPasswordTokenPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserPasswordTokenPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserPasswordTokenPost UserPasswordTokenRequest Source # | Body Param "credentials" - The username of the user to request a token for. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserPasswordTokenPost contentType, MimeRender contentType UserPasswordTokenRequest) => VikunjaRequest UserPasswordTokenPost contentType res accept -> UserPasswordTokenRequest -> VikunjaRequest UserPasswordTokenPost contentType res accept Source # |
userSettingsAvatarGet
userSettingsAvatarGet :: VikunjaRequest UserSettingsAvatarGet MimeNoContent V1UserAvatarProvider MimeJSON Source #
GET /user/settings/avatar
Return user avatar setting
Returns the current user's avatar setting.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsAvatarGet Source #
Instances
Produces UserSettingsAvatarGet MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userSettingsAvatarPost
userSettingsAvatarPost Source #
Arguments
:: (Consumes UserSettingsAvatarPost MimeJSON, MimeRender MimeJSON V1UserAvatarProvider) | |
=> V1UserAvatarProvider | "avatar" - The user's avatar setting |
-> VikunjaRequest UserSettingsAvatarPost MimeJSON ModelsMessage MimeJSON |
POST /user/settings/avatar
Set the user's avatar
Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, default.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsAvatarPost Source #
Instances
Produces UserSettingsAvatarPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserSettingsAvatarPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserSettingsAvatarPost V1UserAvatarProvider Source # | Body Param "avatar" - The user's avatar setting |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserSettingsAvatarPost contentType, MimeRender contentType V1UserAvatarProvider) => VikunjaRequest UserSettingsAvatarPost contentType res accept -> V1UserAvatarProvider -> VikunjaRequest UserSettingsAvatarPost contentType res accept Source # |
userSettingsAvatarUploadPut
userSettingsAvatarUploadPut Source #
Arguments
:: Consumes UserSettingsAvatarUploadPut MimeMultipartFormData | |
=> Avatar | "avatar" - The avatar as single file. |
-> VikunjaRequest UserSettingsAvatarUploadPut MimeMultipartFormData ModelsMessage MimeJSON |
PUT /user/settings/avatar/upload
Upload a user avatar
Upload a user avatar. This will also set the user's avatar provider to "upload"
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsAvatarUploadPut Source #
Instances
Produces UserSettingsAvatarUploadPut MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserSettingsAvatarUploadPut MimeMultipartFormData Source # | multipart/form-data |
Defined in Vikunja.API.User |
userSettingsEmailPost
userSettingsEmailPost Source #
Arguments
:: (Consumes UserSettingsEmailPost MimeJSON, MimeRender MimeJSON UserEmailUpdate) | |
=> UserEmailUpdate | "userEmailUpdate" - The new email address and current password. |
-> VikunjaRequest UserSettingsEmailPost MimeJSON ModelsMessage MimeJSON |
POST /user/settings/email
Update email address
Lets the current user change their email address.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsEmailPost Source #
Instances
Produces UserSettingsEmailPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserSettingsEmailPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserSettingsEmailPost UserEmailUpdate Source # | Body Param "userEmailUpdate" - The new email address and current password. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserSettingsEmailPost contentType, MimeRender contentType UserEmailUpdate) => VikunjaRequest UserSettingsEmailPost contentType res accept -> UserEmailUpdate -> VikunjaRequest UserSettingsEmailPost contentType res accept Source # |
userSettingsGeneralPost
userSettingsGeneralPost Source #
Arguments
:: (Consumes UserSettingsGeneralPost MimeJSON, MimeRender MimeJSON V1UserSettings) | |
=> V1UserSettings | "avatar" - The updated user settings |
-> VikunjaRequest UserSettingsGeneralPost MimeJSON ModelsMessage MimeJSON |
POST /user/settings/general
Change general user settings of the current user.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsGeneralPost Source #
Instances
Produces UserSettingsGeneralPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserSettingsGeneralPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserSettingsGeneralPost V1UserSettings Source # | Body Param "avatar" - The updated user settings |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserSettingsGeneralPost contentType, MimeRender contentType V1UserSettings) => VikunjaRequest UserSettingsGeneralPost contentType res accept -> V1UserSettings -> VikunjaRequest UserSettingsGeneralPost contentType res accept Source # |
userSettingsTokenCaldavGet
userSettingsTokenCaldavGet :: VikunjaRequest UserSettingsTokenCaldavGet MimeNoContent [UserToken] MimeJSON Source #
GET /user/settings/token/caldav
Returns the caldav tokens for the current user
Return the IDs and created dates of all caldav tokens for the current user.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsTokenCaldavGet Source #
Instances
Produces UserSettingsTokenCaldavGet MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userSettingsTokenCaldavIdGet
userSettingsTokenCaldavIdGet Source #
Arguments
:: Id | "id" - Token ID |
-> VikunjaRequest UserSettingsTokenCaldavIdGet MimeNoContent ModelsMessage MimeJSON |
data UserSettingsTokenCaldavIdGet Source #
Instances
Produces UserSettingsTokenCaldavIdGet MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userSettingsTokenCaldavPut
userSettingsTokenCaldavPut :: VikunjaRequest UserSettingsTokenCaldavPut MimeNoContent UserToken MimeJSON Source #
PUT /user/settings/token/caldav
Generate a caldav token
Generates a caldav token which can be used for the caldav api. It is not possible to see the token again after it was generated.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsTokenCaldavPut Source #
Instances
Produces UserSettingsTokenCaldavPut MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userSettingsTotpDisablePost
userSettingsTotpDisablePost Source #
Arguments
:: (Consumes UserSettingsTotpDisablePost MimeJSON, MimeRender MimeJSON UserLogin) | |
=> UserLogin | "totp" - The current user's password (only password is enough). |
-> VikunjaRequest UserSettingsTotpDisablePost MimeJSON ModelsMessage MimeJSON |
POST /user/settings/totp/disable
Disable totp settings
Disables any totp settings for the current user.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsTotpDisablePost Source #
Instances
Produces UserSettingsTotpDisablePost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserSettingsTotpDisablePost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserSettingsTotpDisablePost UserLogin Source # | Body Param "totp" - The current user's password (only password is enough). |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserSettingsTotpDisablePost contentType, MimeRender contentType UserLogin) => VikunjaRequest UserSettingsTotpDisablePost contentType res accept -> UserLogin -> VikunjaRequest UserSettingsTotpDisablePost contentType res accept Source # |
userSettingsTotpEnablePost
userSettingsTotpEnablePost Source #
Arguments
:: (Consumes UserSettingsTotpEnablePost MimeJSON, MimeRender MimeJSON UserTOTPPasscode) | |
=> UserTOTPPasscode | "totp" - The totp passcode. |
-> VikunjaRequest UserSettingsTotpEnablePost MimeJSON ModelsMessage MimeJSON |
POST /user/settings/totp/enable
Enable a previously enrolled totp setting.
Enables a previously enrolled totp setting by providing a totp passcode.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsTotpEnablePost Source #
Instances
Produces UserSettingsTotpEnablePost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
Consumes UserSettingsTotpEnablePost MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasBodyParam UserSettingsTotpEnablePost UserTOTPPasscode Source # | Body Param "totp" - The totp passcode. |
Defined in Vikunja.API.User Methods setBodyParam :: (Consumes UserSettingsTotpEnablePost contentType, MimeRender contentType UserTOTPPasscode) => VikunjaRequest UserSettingsTotpEnablePost contentType res accept -> UserTOTPPasscode -> VikunjaRequest UserSettingsTotpEnablePost contentType res accept Source # |
userSettingsTotpEnrollPost
userSettingsTotpEnrollPost :: VikunjaRequest UserSettingsTotpEnrollPost MimeNoContent UserTOTP MimeJSON Source #
POST /user/settings/totp/enroll
Enroll a user into totp
Creates an initial setup for the user in the db. After this step, the user needs to verify they have a working totp setup with the "enable totp" endpoint.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsTotpEnrollPost Source #
Instances
Produces UserSettingsTotpEnrollPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userSettingsTotpGet
userSettingsTotpGet :: VikunjaRequest UserSettingsTotpGet MimeNoContent UserTOTP MimeJSON Source #
GET /user/settings/totp
Totp setting for the current user
Returns the current user totp setting or an error if it is not enabled.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsTotpGet Source #
Instances
Produces UserSettingsTotpGet MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userSettingsTotpQrcodeGet
userSettingsTotpQrcodeGet :: VikunjaRequest UserSettingsTotpQrcodeGet MimeNoContent FilePath MimeJSON Source #
GET /user/settings/totp/qrcode
Totp QR Code
Returns a qr code for easier setup at end user's devices.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserSettingsTotpQrcodeGet Source #
Instances
Produces UserSettingsTotpQrcodeGet MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userTimezonesGet
userTimezonesGet :: VikunjaRequest UserTimezonesGet MimeNoContent [Text] MimeJSON Source #
GET /user/timezones
Get all available time zones on this vikunja instance
Because available time zones depend on the system Vikunja is running on, this endpoint returns a project of all valid time zones this particular Vikunja instance can handle. The project of time zones is not sorted, you should sort it on the client.
AuthMethod: AuthApiKeyJWTKeyAuth
data UserTimezonesGet Source #
Instances
Produces UserTimezonesGet MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
userTokenPost
userTokenPost :: VikunjaRequest UserTokenPost MimeNoContent AuthToken MimeJSON Source #
POST /user/token
Renew user token
Returns a new valid jwt user token with an extended length.
data UserTokenPost Source #
Instances
Produces UserTokenPost MimeJSON Source # | application/json |
Defined in Vikunja.API.User |
usernameAvatarGet
Arguments
:: Username | "username" - The username of the user who's avatar you want to get |
-> VikunjaRequest UsernameAvatarGet MimeNoContent FilePath MimeOctetStream |
GET /{username}/avatar
User Avatar
Returns the user avatar as image.
data UsernameAvatarGet Source #
Instances
Produces UsernameAvatarGet MimeOctetStream Source # | application/octet-stream |
Defined in Vikunja.API.User | |
HasOptionalParam UsernameAvatarGet Size Source # | Optional Param "size" - The size of the avatar you want to get. If bigger than the max configured size this will be adjusted to the maximum size. |
Defined in Vikunja.API.User Methods applyOptionalParam :: VikunjaRequest UsernameAvatarGet contentType res accept -> Size -> VikunjaRequest UsernameAvatarGet contentType res accept Source # (-&-) :: VikunjaRequest UsernameAvatarGet contentType res accept -> Size -> VikunjaRequest UsernameAvatarGet contentType res accept Source # |
usersGet
usersGet :: VikunjaRequest UsersGet MimeNoContent [UserUser] MimeJSON Source #
GET /users
Get users
Search for a user by its username, name or full email. Name (not username) or email require that the user has enabled this in their settings.
AuthMethod: AuthApiKeyJWTKeyAuth
Instances
Produces UsersGet MimeJSON Source # | application/json |
Defined in Vikunja.API.User | |
HasOptionalParam UsersGet S Source # | Optional Param "s" - The search criteria. |
Defined in Vikunja.API.User Methods applyOptionalParam :: VikunjaRequest UsersGet contentType res accept -> S -> VikunjaRequest UsersGet contentType res accept Source # (-&-) :: VikunjaRequest UsersGet contentType res accept -> S -> VikunjaRequest UsersGet contentType res accept Source # |