Generated go sdk for the vikunja api
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

7.3 KiB

\UserApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
LoginPost Post /login Login
RegisterPost Post /register Register
UserConfirmPost Post /user/confirm Confirm the email of a new user
UserGet Get /user Get user information
UserPasswordPost Post /user/password Change password
UserPasswordResetPost Post /user/password/reset Resets a password
UserPasswordTokenPost Post /user/password/token Request password reset token
UsersGet Get /users Get users

LoginPost

V1Token LoginPost(ctx, credentials) Login

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

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
credentials ModelsUserLogin The login credentials

Return type

V1Token

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RegisterPost

ModelsUser RegisterPost(ctx, credentials) Register

Creates a new user account.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
credentials ModelsApiUserPassword The user credentials

Return type

ModelsUser

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserConfirmPost

ModelsMessage UserConfirmPost(ctx, credentials) Confirm the email of a new user

Confirms the email of a newly registered user.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
credentials ModelsEmailConfirm The token.

Return type

ModelsMessage

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserGet

ModelsUser UserGet(ctx, ) Get user information

Returns the current user object.

Required Parameters

This endpoint does not need any parameter.

Return type

ModelsUser

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserPasswordPost

ModelsMessage UserPasswordPost(ctx, userPassword) Change password

Lets the current user change its password.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
userPassword V1UserPassword The current and new password.

Return type

ModelsMessage

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserPasswordResetPost

ModelsMessage UserPasswordResetPost(ctx, credentials) Resets a password

Resets a user email with a previously reset token.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
credentials ModelsPasswordReset The token with the new password.

Return type

ModelsMessage

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UserPasswordTokenPost

ModelsMessage UserPasswordTokenPost(ctx, credentials) Request password reset token

Requests a token to reset a users password. The token is sent via email.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
credentials ModelsPasswordTokenRequest The username of the user to request a token for.

Return type

ModelsMessage

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UsersGet

[]ModelsUser UsersGet(ctx, optional) Get users

Lists all users (without emailadresses). Also possible to search for a specific user.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
s string Search for a user by its name.

Return type

**[]ModelsUser**

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]