vikunja-api-0.24.6.0: Auto-generated vikunja-api API Client
Safe HaskellNone
LanguageHaskell2010

Vikunja.API.User

Description

 
Synopsis

Operations

User

userConfirmPost

userConfirmPost Source #

POST /user/confirm

Confirm the email of a new user

Confirms the email of a newly registered user.

data UserConfirmPost Source #

Instances

Instances details
Produces UserConfirmPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserConfirmPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserConfirmPost UserEmailConfirm Source #

Body Param "credentials" - The token.

Instance details

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 #

POST /user/deletion/cancel

Abort a user deletion request

Aborts an in-progress user deletion.

data UserDeletionCancelPost Source #

Instances

Instances details
Produces UserDeletionCancelPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserDeletionCancelPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserDeletionCancelPost V1UserPasswordConfirmation Source #

Body Param "credentials" - The user password to confirm.

Instance details

Defined in Vikunja.API.User

userDeletionConfirmPost

userDeletionConfirmPost Source #

POST /user/deletion/confirm

Confirm a user deletion request

Confirms the deletion request of a user sent via email.

data UserDeletionConfirmPost Source #

Instances

Instances details
Produces UserDeletionConfirmPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserDeletionConfirmPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserDeletionConfirmPost V1UserDeletionRequestConfirm Source #

Body Param "credentials" - The token.

Instance details

Defined in Vikunja.API.User

userDeletionRequestPost

userDeletionRequestPost Source #

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

Instances details
Produces UserDeletionRequestPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserDeletionRequestPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserDeletionRequestPost V1UserPasswordConfirmation Source #

Body Param "credentials" - The user password.

Instance details

Defined in Vikunja.API.User

userExportDownloadPost

userExportDownloadPost Source #

POST /user/export/download

Download a user data export.

AuthMethod: AuthApiKeyJWTKeyAuth

data UserExportDownloadPost Source #

Instances

Instances details
Produces UserExportDownloadPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserExportDownloadPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserExportDownloadPost V1UserPasswordConfirmation Source #

Body Param "password" - User password to confirm the download.

Instance details

Defined in Vikunja.API.User

userExportRequestPost

userExportRequestPost Source #

POST /user/export/request

Request a user data export.

AuthMethod: AuthApiKeyJWTKeyAuth

data UserExportRequestPost Source #

Instances

Instances details
Produces UserExportRequestPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserExportRequestPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserExportRequestPost V1UserPasswordConfirmation Source #

Body Param "password" - User password to confirm the data export request.

Instance details

Defined in Vikunja.API.User

userGet

userGet :: VikunjaRequest UserGet MimeNoContent V1UserWithSettings MimeJSON Source #

GET /user

Get user information

Returns the current user object with their settings.

AuthMethod: AuthApiKeyJWTKeyAuth

data UserGet Source #

Instances

Instances details
Produces UserGet MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

userPasswordPost

userPasswordPost Source #

POST /user/password

Change password

Lets the current user change its password.

AuthMethod: AuthApiKeyJWTKeyAuth

data UserPasswordPost Source #

Instances

Instances details
Produces UserPasswordPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserPasswordPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserPasswordPost V1UserPassword Source #

Body Param "userPassword" - The current and new password.

Instance details

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 #

POST /user/password/reset

Resets a password

Resets a user email with a previously reset token.

data UserPasswordResetPost Source #

Instances

Instances details
Produces UserPasswordResetPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserPasswordResetPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserPasswordResetPost UserPasswordReset Source #

Body Param "credentials" - The token with the new password.

Instance details

Defined in Vikunja.API.User

userPasswordTokenPost

userPasswordTokenPost Source #

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

Instances details
Produces UserPasswordTokenPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserPasswordTokenPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserPasswordTokenPost UserPasswordTokenRequest Source #

Body Param "credentials" - The username of the user to request a token for.

Instance details

Defined in Vikunja.API.User

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

Instances details
Produces UserSettingsAvatarGet MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

userSettingsAvatarPost

userSettingsAvatarPost Source #

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

Instances details
Produces UserSettingsAvatarPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserSettingsAvatarPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserSettingsAvatarPost V1UserAvatarProvider Source #

Body Param "avatar" - The user's avatar setting

Instance details

Defined in Vikunja.API.User

userSettingsAvatarUploadPut

userSettingsAvatarUploadPut Source #

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

Instances details
Produces UserSettingsAvatarUploadPut MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserSettingsAvatarUploadPut MimeMultipartFormData Source #
multipart/form-data
Instance details

Defined in Vikunja.API.User

userSettingsEmailPost

userSettingsEmailPost Source #

POST /user/settings/email

Update email address

Lets the current user change their email address.

AuthMethod: AuthApiKeyJWTKeyAuth

data UserSettingsEmailPost Source #

Instances

Instances details
Produces UserSettingsEmailPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserSettingsEmailPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserSettingsEmailPost UserEmailUpdate Source #

Body Param "userEmailUpdate" - The new email address and current password.

Instance details

Defined in Vikunja.API.User

userSettingsGeneralPost

userSettingsGeneralPost Source #

POST /user/settings/general

Change general user settings of the current user.

AuthMethod: AuthApiKeyJWTKeyAuth

data UserSettingsGeneralPost Source #

Instances

Instances details
Produces UserSettingsGeneralPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserSettingsGeneralPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserSettingsGeneralPost V1UserSettings Source #

Body Param "avatar" - The updated user settings

Instance details

Defined in Vikunja.API.User

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

Instances details
Produces UserSettingsTokenCaldavGet MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

userSettingsTokenCaldavIdGet

userSettingsTokenCaldavIdGet Source #

GET /user/settings/token/caldav/{id}

Delete a caldav token by id

AuthMethod: AuthApiKeyJWTKeyAuth

data UserSettingsTokenCaldavIdGet Source #

Instances

Instances details
Produces UserSettingsTokenCaldavIdGet MimeJSON Source #
application/json
Instance details

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

Instances details
Produces UserSettingsTokenCaldavPut MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

userSettingsTotpDisablePost

userSettingsTotpDisablePost Source #

POST /user/settings/totp/disable

Disable totp settings

Disables any totp settings for the current user.

AuthMethod: AuthApiKeyJWTKeyAuth

data UserSettingsTotpDisablePost Source #

Instances

Instances details
Produces UserSettingsTotpDisablePost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserSettingsTotpDisablePost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserSettingsTotpDisablePost UserLogin Source #

Body Param "totp" - The current user's password (only password is enough).

Instance details

Defined in Vikunja.API.User

userSettingsTotpEnablePost

userSettingsTotpEnablePost Source #

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

Instances details
Produces UserSettingsTotpEnablePost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

Consumes UserSettingsTotpEnablePost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasBodyParam UserSettingsTotpEnablePost UserTOTPPasscode Source #

Body Param "totp" - The totp passcode.

Instance details

Defined in Vikunja.API.User

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

Instances details
Produces UserSettingsTotpEnrollPost MimeJSON Source #
application/json
Instance details

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

Instances details
Produces UserSettingsTotpGet MimeJSON Source #
application/json
Instance details

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

Instances details
Produces UserSettingsTotpQrcodeGet MimeJSON Source #
application/json
Instance details

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

Instances details
Produces UserTimezonesGet MimeJSON Source #
application/json
Instance details

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

Instances details
Produces UserTokenPost MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

usernameAvatarGet

usernameAvatarGet Source #

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

Instances details
Produces UsernameAvatarGet MimeOctetStream Source #
application/octet-stream
Instance details

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.

Instance details

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

data UsersGet Source #

Instances

Instances details
Produces UsersGet MimeJSON Source #
application/json
Instance details

Defined in Vikunja.API.User

HasOptionalParam UsersGet S Source #

Optional Param "s" - The search criteria.

Instance details

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 #