Authentification

Authentification routes.

Authenticate a user

Authenticate a user with a password or token.

Request
Request Body schema: application/json

A JSON object containing authentication information.

One of:
user
required
string

The mail or alias of the user.

password
required
string

The password of the user.

hub
boolean

The hub flag specifies whether the token should be issued for the last used hub or without it.

remember
boolean

The remember flag indicates if the session should be valid for a period of 30 days.

Responses
200

Successful operation

401

Unauthorized

422

Unprocessable Content

post/auth
Request samples
application/json
{
  • "user": "titan@nordantech.com",
  • "password": "WoWar1chUnsicher?"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "b3f7d7d89e16142144126daff5ad0d9522542005",
  • "data": {
    },
  • "timestamp": 1656410747548
}

Authenticate a user with code

Authenticate the current user using a login code.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing authentication information.

code
required
string

The multi factor authentication code.

Responses
200

Successful operation

401

Unauthorized

422

Unprocessable Content

post/auth/code
Request samples
application/json
{
  • "code": "013120"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "b3f7d7d89e16142144126daff5ad0d9522542005",
  • "data": {
    },
  • "timestamp": 1656410747548
}

Authenticate a hub change

Authenticate the change of the authenticated hub.

SecurityJWT
Request
path Parameters
hub
required
string or integer

The id/hash of the hub.

Responses
200

Successful operation

401

Unauthorized

post/auth/hub/{hub}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "fe1a21dc09531b90a716b24338cc0d41f2160ebe",
  • "data": {
    },
  • "timestamp": 1653472490807
}

Authenticate a user impersonation

Authenticate a user impersionation for the authenticated hub.

SecurityJWT
Request
path Parameters
user
required
string or integer

The id/hash of the user.

Responses
200

Successful operation

post/auth/impersonation/{user}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "fe1a21dc09531b90a716b24338cc0d41f2160ebe",
  • "data": {
    },
  • "timestamp": 1710350349192
}

Authenticate a verification

Authenticate a link verification.

Request
path Parameters
verification
required
string or integer

The id/hash of the verification.

query Parameters
signature
required
string

The signature for the verification.

Responses
200

Successful operation

post/auth/verification/{verification}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "89e26875f74025762ebd0ace1c14a820a0746068",
  • "data": {
    },
  • "timestamp": 1673602323924
}

Reset a user password

Reset the password for a user.

Request
Request Body schema: application/json

A JSON object containing authentication information.

user
required
string

The mail or alias of the user.

Responses
200

Successful operation

422

Unprocessable Content

post/auth/password/reset
Request samples
application/json
{
  • "user": "titan@nordantech.com"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1655139105008
}

Initiate a recovery

Initiate a mulit factor authentication recovery for a user.

Request
Request Body schema: application/json

A JSON object containing authentication information.

user
required
string

The mail or alias of the user.

Responses
200

Successful operation

422

Unprocessable Content

post/auth/recovery/initiate
Request samples
application/json
{
  • "user": "titan@nordantech.com"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "97d170e1550eee4afc0af065b78cda302a97674c",
  • "data": { },
  • "timestamp": 1710437656773
}

Invalidate the hub

Invalidate the authenticated hub.

SecurityJWT
Responses
200

Successful operation

post/auth/hub/invalidate
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "601fc3fa7ed95326fd528d11cb4f451ddffa46b6",
  • "data": {
    },
  • "timestamp": 1685106468799
}

Invalidate the user

Invalidate the authenticated user.

SecurityJWT
Responses
200

Successful operation

post/auth/invalidate
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1655138528200
}

Invalidate the user impersonation

Invalidate the authenticated user impersonation.

SecurityJWT
Responses
200

Successful operation

post/auth/impersonation/invalidate
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "7cfeb65119b6e202e3d42bc66d2f2f60b69822fa",
  • "data": {
    },
  • "timestamp": 1710350555853
}

Ping

Refresh the current token silently.

SecurityJWT
Responses
200

Successful operation

post/auth/ping
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1655195789643
}

Refresh

Refresh the current token.

SecurityJWT
Responses
200

Successful operation

post/auth/refresh
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "0b7c606d5685ed09a5d5694505fa4db0baed6f46",
  • "data": {
    },
  • "timestamp": 1656510275631
}