Skip to main content

Auth API (1.1.0)

Download OpenAPI specification:Download

User authentication microservice API

auth

User authentication related operations

Login a user

Login a user with email and password

Request Body schema: application/json
required
email
required
string <email>
password
required
string <password>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "accessToken": "string",
  • "refreshToken": "string"
}

Register a user

Register a new user with email and password

Request Body schema: application/json
required
email
required
string <email>
password
required
string <password>
username
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "pa$$word",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "accessToken": "string",
  • "refreshToken": "string"
}

Logout a user

Logout a user

Responses

token

Token related operations

Validate a token

Validate a token

header Parameters
Authorization
required
string

Bearer token

Responses

Refresh a token

Refresh a token

header Parameters
required
object

Refresh token

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string"
}

Get user data

Get user data

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com"
}