Vikunja.API.Auth

Operations

Auth

getTokenOpenid

getTokenOpenid

Arguments

:: (Consumes GetTokenOpenid MimeJSON, MimeRender MimeJSON OpenidCallback)

=> OpenidCallback

"callback" - The openid callback

-> Provider

"provider" - The OpenID Connect provider key as returned by the /info endpoint

-> VikunjaRequest GetTokenOpenid MimeJSON AuthToken MimeJSON

POST /auth/openid/{provider}/callback

Authenticate a user with OpenID Connect

After a redirect from the OpenID Connect provider to the frontend has been made with the authentication code, this endpoint can be used to obtain a jwt token for that user and thus log them in.

AuthMethod: AuthApiKeyJWTKeyAuth

data GetTokenOpenid

Instances

Produces GetTokenOpenid MimeJSON

application/json

Defined in Vikunja.API.Auth

Consumes GetTokenOpenid MimeJSON

application/json

Defined in Vikunja.API.Auth

HasBodyParam GetTokenOpenid OpenidCallback

Body Param "callback" - The openid callback

Defined in Vikunja.API.Auth

Methods

setBodyParam :: (Consumes GetTokenOpenid contentType, MimeRender contentType OpenidCallback) => VikunjaRequest GetTokenOpenid contentType res accept -> OpenidCallback -> VikunjaRequest GetTokenOpenid contentType res accept

loginPost

loginPost

Arguments

:: (Consumes LoginPost MimeJSON, MimeRender MimeJSON UserLogin)

=> UserLogin

"credentials" - The login credentials

-> VikunjaRequest LoginPost MimeJSON AuthToken MimeJSON

POST /login

Login

Logs a user in. Returns a JWT-Token to authenticate further requests.

data LoginPost

Instances

Produces LoginPost MimeJSON

application/json

Defined in Vikunja.API.Auth

Consumes LoginPost MimeJSON

application/json

Defined in Vikunja.API.Auth

HasBodyParam LoginPost UserLogin

Body Param "credentials" - The login credentials

Defined in Vikunja.API.Auth

Methods

setBodyParam :: (Consumes LoginPost contentType, MimeRender contentType UserLogin) => VikunjaRequest LoginPost contentType res accept -> UserLogin -> VikunjaRequest LoginPost contentType res accept

registerPost

registerPost

Arguments

:: (Consumes RegisterPost MimeJSON, MimeRender MimeJSON UserAPIUserPassword)

=> UserAPIUserPassword

"credentials" - The user credentials

-> VikunjaRequest RegisterPost MimeJSON UserUser MimeJSON

POST /register

Register

Creates a new user account.

data RegisterPost

Instances

Produces RegisterPost MimeJSON

application/json

Defined in Vikunja.API.Auth

Consumes RegisterPost MimeJSON

application/json

Defined in Vikunja.API.Auth

HasBodyParam RegisterPost UserAPIUserPassword

Body Param "credentials" - The user credentials

Defined in Vikunja.API.Auth

Methods

setBodyParam :: (Consumes RegisterPost contentType, MimeRender contentType UserAPIUserPassword) => VikunjaRequest RegisterPost contentType res accept -> UserAPIUserPassword -> VikunjaRequest RegisterPost contentType res accept