User

Content negotiation

User Endpoints

admin

Method URI Name Summary
POST /v1/user/login login Login

Paths

Login (login)

POST /v1/user/login

login for administration users

Parameters

Name Source Type Go type Separator Required Default Description
body body UserLoginRequest models.UserLoginRequest ✓

All responses

Code Status Description Has headers Schema
200 OK A successful response. schema

Responses

200 - A successful response.

Status: OK

Schema

UserLoginResponse

Models

JwtToken

Properties

Name Type Go type Required Default Description Example
accessExpire int64 (formatted integer) int64 ✓
accessToken string string ✓
refreshAfter int64 (formatted integer) int64 ✓

ResponseStatus

Properties

Name Type Go type Required Default Description Example
statusCode int64 (formatted integer) int64 ✓ RFC http status code, ie. 204, etc - https:go.dev/src/net/http/status.go
statusMessage string string ✓ status message

User

Properties

Name Type Go type Required Default Description Example
email string string ✓ email address
firstName string string ✓ first name
id int64 (formatted integer) int64 ✓ user id
lastName string string ✓ last name
password string string ✓ password

UserLoginRequest

Properties

Name Type Go type Required Default Description Example
email string string ✓ email address
password string string ✓ password

UserLoginResponse

Properties

Name Type Go type Required Default Description Example
jwt JwtToken JwtToken ✓ JwtToken object
status ResponseStatus ResponseStatus ✓ a ResponseStatus object
user User User ✓ User object

Feedback

Was this page helpful?


Last modified January 19, 2022: content update (ec6fd04)