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

Payload
curl

application/json

{"user": "titan@nordantech.com",
"password": "WoWar1chUnsicher?"
}

Response samples

application/json

{"success": true,
"hash": "b3f7d7d89e16142144126daff5ad0d9522542005",
"data": {"user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"email": "titan@nordantech.com",
"password_modified_time": "2022-06-27T09:48:05.000000Z",
"password_age": 1,
"password_age_relative_time": "yesterday",
"password_update": false,
"login_confirmation": false,
"locale": 1,
"language": 1,
"intercom": "3b9a556c35aaf1d710b7dd5d6749bb682ca67a87c68f5aac4f4496fae6d7da21",
"onboarding": false,
"state": "{\"dashboard\":{\"idSeed\":5,\"items\":[{\"type\":\"dashboardeffectsoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardeffectsoverviewwidget1\",\"columnIndex\":0},{\"type\":\"dashboardeffectsscorewidget\",\"id\":\"dashboardhome-1120_dashboardeffectsscorewidget2\",\"columnIndex\":0},{\"type\":\"dashboardscheduleoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardscheduleoverviewwidget3\",\"columnIndex\":1},{\"type\":\"dashboardschedulescorewidget\",\"id\":\"dashboardhome-1120_dashboardschedulescorewidget4\",\"columnIndex\":1}],\"columnWidths\":[0.5,0.5]},\"dashboardeffectsoverviewwidget\":{\"height\":410},\"dashboardscheduleoverviewwidget\":{\"height\":410},\"dashboardeffectsscorewidget\":{\"height\":200},\"dashboardschedulescorewidget\":{\"height\":200}}",
"registration_time": "2019-11-14T16:07:39.000000Z",
"terms_accepted_time": "2019-11-14T16:07:39.000000Z",
"terms_reconfirmation": false,
"status": 1,
"model": "User",
"image": {"id": 1,
"hash": "613e66e4f1e3ef01a93cac169b75d4d9f43a8de4",
"extension": "jpg",
"mime": "image/jpeg",
"created_time": "2022-05-18T09:04:39.000000Z",
"modified_time": "2022-05-18T09:04:39.000000Z",
"modified_user_time": "2022-05-18T09:04:39.000000Z",
"model": "Image"
},
"hubs": [{"id": 1,
"hash": "1daa7da5ba074972eb3d4552414928f5201541f3",
"name": "Nordantech",
"trial": true,
"expiration_time": "2023-06-03T23:59:59.000000Z",
"remaining_days": 355,
"remaining_time": "355 days",
"model": "Hub"
},
{"id": 2,
"hash": "9f7c05fde1b7740a7dae3cc605ac360c796eb2c4",
"name": "Falcon",
"trial": true,
"expiration_time": "2022-07-13T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 days",
"model": "Hub"
}
]
},
"hub": {"id": 1,
"hash": "1ff203f04def3d63d77cb9e212ecabca04a637ca",
"name": "Nordantech",
"trial": true,
"expiration_time": "2022-06-30T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 Tage",
"model": "Hub"
},
"role": 5,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJhcGkubm9yZGFuLnRlY2giLCJqdGkiOiI1YzI1ODMxMmNhMWQzNGRhOGU0OTc5YWE0NjQ5ODk3ZTYyNTRlODY5IiwibmJmIjoxNjUzOTg1NzYwLjI5ODMyMywiaWF0IjoxNjUzOTg1NzYwLjI5ODMyOSwiZXhwIjoxNjU2NTc3NzEyLCJzdWIiOiJjOTk4NWQ2NTI4ZGM3YWQwZDZmYWEyYjk5YTU0NTAzNGM1MDYzNDdiIiwiaHN1IjoiNWFkOTYyMmJiYTk5ZDY4ZmI1ZTY3MjhiZjY1MTI0YWFhM2EzZTMxMSIsInBhdCI6OSwic2VzIjo1NDkwNiwiaHViIjoxMDIyLCJtZmEiOm51bGwsInNjcCI6IioifQ.mr8PI3HxZYFYWMsh3MXlzKuJ_fvFCzv1jmXdsPMG6zctB_-qk54IQqeVIR1Att9lDo4te65PDNmSBPYLucGYug",
"ttl": 30,
"session": {"id": 54906,
"hash": "25e0e7d4a5167e0c7ff19471f767fbf77a87623f",
"model": "UserSession"
}
},
"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 authentification code.

Responses

200

Successful operation

401

Unauthorized

422

Unprocessable Content

post/auth/code

Request samples

Payload
curl

application/json

{"code": "123456"
}

Response samples

application/json

{"success": true,
"hash": "b3f7d7d89e16142144126daff5ad0d9522542005",
"data": {"user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"email": "titan@nordantech.com",
"password_modified_time": "2022-06-27T09:48:05.000000Z",
"password_age": 1,
"password_age_relative_time": "yesterday",
"password_update": false,
"login_confirmation": false,
"locale": 1,
"language": 1,
"intercom": "3b9a556c35aaf1d710b7dd5d6749bb682ca67a87c68f5aac4f4496fae6d7da21",
"onboarding": false,
"state": "{\"dashboard\":{\"idSeed\":5,\"items\":[{\"type\":\"dashboardeffectsoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardeffectsoverviewwidget1\",\"columnIndex\":0},{\"type\":\"dashboardeffectsscorewidget\",\"id\":\"dashboardhome-1120_dashboardeffectsscorewidget2\",\"columnIndex\":0},{\"type\":\"dashboardscheduleoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardscheduleoverviewwidget3\",\"columnIndex\":1},{\"type\":\"dashboardschedulescorewidget\",\"id\":\"dashboardhome-1120_dashboardschedulescorewidget4\",\"columnIndex\":1}],\"columnWidths\":[0.5,0.5]},\"dashboardeffectsoverviewwidget\":{\"height\":410},\"dashboardscheduleoverviewwidget\":{\"height\":410},\"dashboardeffectsscorewidget\":{\"height\":200},\"dashboardschedulescorewidget\":{\"height\":200}}",
"registration_time": "2019-11-14T16:07:39.000000Z",
"terms_accepted_time": "2019-11-14T16:07:39.000000Z",
"terms_reconfirmation": false,
"status": 1,
"model": "User",
"image": {"id": 1,
"hash": "613e66e4f1e3ef01a93cac169b75d4d9f43a8de4",
"extension": "jpg",
"mime": "image/jpeg",
"created_time": "2022-05-18T09:04:39.000000Z",
"modified_time": "2022-05-18T09:04:39.000000Z",
"modified_user_time": "2022-05-18T09:04:39.000000Z",
"model": "Image"
},
"hubs": [{"id": 1,
"hash": "1daa7da5ba074972eb3d4552414928f5201541f3",
"name": "Nordantech",
"trial": true,
"expiration_time": "2023-06-03T23:59:59.000000Z",
"remaining_days": 355,
"remaining_time": "355 days",
"model": "Hub"
},
{"id": 2,
"hash": "9f7c05fde1b7740a7dae3cc605ac360c796eb2c4",
"name": "Falcon",
"trial": true,
"expiration_time": "2022-07-13T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 days",
"model": "Hub"
}
]
},
"hub": {"id": 1,
"hash": "1ff203f04def3d63d77cb9e212ecabca04a637ca",
"name": "Nordantech",
"trial": true,
"expiration_time": "2022-06-30T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 Tage",
"model": "Hub"
},
"role": 5,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJhcGkubm9yZGFuLnRlY2giLCJqdGkiOiI1YzI1ODMxMmNhMWQzNGRhOGU0OTc5YWE0NjQ5ODk3ZTYyNTRlODY5IiwibmJmIjoxNjUzOTg1NzYwLjI5ODMyMywiaWF0IjoxNjUzOTg1NzYwLjI5ODMyOSwiZXhwIjoxNjU2NTc3NzEyLCJzdWIiOiJjOTk4NWQ2NTI4ZGM3YWQwZDZmYWEyYjk5YTU0NTAzNGM1MDYzNDdiIiwiaHN1IjoiNWFkOTYyMmJiYTk5ZDY4ZmI1ZTY3MjhiZjY1MTI0YWFhM2EzZTMxMSIsInBhdCI6OSwic2VzIjo1NDkwNiwiaHViIjoxMDIyLCJtZmEiOm51bGwsInNjcCI6IioifQ.mr8PI3HxZYFYWMsh3MXlzKuJ_fvFCzv1jmXdsPMG6zctB_-qk54IQqeVIR1Att9lDo4te65PDNmSBPYLucGYug",
"ttl": 30,
"session": {"id": 54906,
"hash": "25e0e7d4a5167e0c7ff19471f767fbf77a87623f",
"model": "UserSession"
}
},
"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

post/auth/hub/{hub}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "fe1a21dc09531b90a716b24338cc0d41f2160ebe",
"data": {"user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"email": "titan@nordantech.com",
"password_modified_time": "2022-06-27T09:48:05.000000Z",
"password_age": 1,
"password_age_relative_time": "yesterday",
"password_update": false,
"login_confirmation": false,
"locale": 1,
"language": 1,
"intercom": "3b9a556c35aaf1d710b7dd5d6749bb682ca67a87c68f5aac4f4496fae6d7da21",
"onboarding": false,
"state": "{\"dashboard\":{\"idSeed\":5,\"items\":[{\"type\":\"dashboardeffectsoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardeffectsoverviewwidget1\",\"columnIndex\":0},{\"type\":\"dashboardeffectsscorewidget\",\"id\":\"dashboardhome-1120_dashboardeffectsscorewidget2\",\"columnIndex\":0},{\"type\":\"dashboardscheduleoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardscheduleoverviewwidget3\",\"columnIndex\":1},{\"type\":\"dashboardschedulescorewidget\",\"id\":\"dashboardhome-1120_dashboardschedulescorewidget4\",\"columnIndex\":1}],\"columnWidths\":[0.5,0.5]},\"dashboardeffectsoverviewwidget\":{\"height\":410},\"dashboardscheduleoverviewwidget\":{\"height\":410},\"dashboardeffectsscorewidget\":{\"height\":200},\"dashboardschedulescorewidget\":{\"height\":200}}",
"registration_time": "2019-11-14T16:07:39.000000Z",
"terms_accepted_time": "2019-11-14T16:07:39.000000Z",
"terms_reconfirmation": false,
"status": 1,
"model": "User",
"image": {"id": 1,
"hash": "613e66e4f1e3ef01a93cac169b75d4d9f43a8de4",
"extension": "jpg",
"mime": "image/jpeg",
"created_time": "2022-05-18T09:04:39.000000Z",
"modified_time": "2022-05-18T09:04:39.000000Z",
"modified_user_time": "2022-05-18T09:04:39.000000Z",
"model": "Image"
},
"hubs": [{"id": 1,
"hash": "1daa7da5ba074972eb3d4552414928f5201541f3",
"name": "Nordantech",
"trial": true,
"expiration_time": "2023-06-03T23:59:59.000000Z",
"remaining_days": 355,
"remaining_time": "355 days",
"model": "Hub"
},
{"id": 2,
"hash": "9f7c05fde1b7740a7dae3cc605ac360c796eb2c4",
"name": "Falcon",
"trial": true,
"expiration_time": "2022-07-13T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 days",
"model": "Hub"
}
]
},
"hub": {"id": 1,
"hash": "1ff203f04def3d63d77cb9e212ecabca04a637ca",
"name": "Nordantech",
"trial": true,
"expiration_time": "2022-06-30T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 Tage",
"model": "Hub"
},
"role": 5,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJhcGkubm9yZGFuLnRlY2giLCJqdGkiOiI1YzI1ODMxMmNhMWQzNGRhOGU0OTc5YWE0NjQ5ODk3ZTYyNTRlODY5IiwibmJmIjoxNjUzOTg1NzYwLjI5ODMyMywiaWF0IjoxNjUzOTg1NzYwLjI5ODMyOSwiZXhwIjoxNjU2NTc3NzEyLCJzdWIiOiJjOTk4NWQ2NTI4ZGM3YWQwZDZmYWEyYjk5YTU0NTAzNGM1MDYzNDdiIiwiaHN1IjoiNWFkOTYyMmJiYTk5ZDY4ZmI1ZTY3MjhiZjY1MTI0YWFhM2EzZTMxMSIsInBhdCI6OSwic2VzIjo1NDkwNiwiaHViIjoxMDIyLCJtZmEiOm51bGwsInNjcCI6IioifQ.mr8PI3HxZYFYWMsh3MXlzKuJ_fvFCzv1jmXdsPMG6zctB_-qk54IQqeVIR1Att9lDo4te65PDNmSBPYLucGYug",
"ttl": 30,
"session": {"id": 54906,
"hash": "25e0e7d4a5167e0c7ff19471f767fbf77a87623f",
"model": "UserSession"
}
},
"timestamp": 1653472490807
}

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

curl

Response samples

application/json

{"success": true,
"hash": "89e26875f74025762ebd0ace1c14a820a0746068",
"data": {"user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"email": "titan@nordantech.com",
"login_confirmation": false,
"locale": 1,
"language": 1,
"status": 1,
"model": "User"
},
"activation": "ed89d4ea96f023d252aa6882658f311b2744b72e",
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJmYWxjb24uYmFja2VuZCIsImp0aSI6IjllNzA5ODcxNDk5YWJkZTcwZGNmZDFhZjk0ZTQxZTI0ZTUwNDZlOGMiLCJuYmYiOjE2NTUxOTg0OTkuNzc0NjE4LCJpYXQiOjE2NTUxOTg0OTkuNzc0NjY1LCJleHAiOjE2NTUyMDAyOTkuNzc0NDk2LCJ0dGwiOjMwLCJzdWIiOiJkMzBjM2Q0MGM1OGI0ODVkODg2ZTI4NTM0MDcwN2VlOWRhNTRlYjBlIiwiaHN1IjoiNWFkOTYyMmJiYTk5ZDY4ZmI1ZTY3MjhiZjY1MTI0YWFhM2EzZTMxMSIsInNlcyI6NTQsImh1YiI6bnVsbCwibWZhIjpudWxsLCJzY3AiOiJ1c2VyaW52aXRlLmZpbmlzaCJ9.DstHf5EXqwN2RMjRv5CzPx9C2iTpPZ8RfrvYaViM4dU8w86p5bruAA_120mcBb6puZVonWWmcUuxKle0Cg1EeA",
"ttl": 30,
"session": {"id": 54,
"hash": "462b1f5de116285c1b72f9a3c6dd23dbe28d99a5",
"model": "UserSession"
}
},
"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

Payload
curl

application/json

{"user": "titan@nordantech.com"
}

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1655139105008
}

Invalidate the hub

Invalidate the authenticated hub.

SecurityJWT

Responses

200

Successful operation

post/auth/hub/invalidate

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1654012865391
}

Invalidate the user

Invalidate the given user.

SecurityJWT

Responses

200

Successful operation

post/auth/invalidate

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
"data": { },
"timestamp": 1655138528200
}

Ping

Refresh the current token silently.

SecurityJWT

Responses

200

Successful operation

post/auth/ping

Request samples

curl

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

curl

Response samples

application/json

{"success": true,
"hash": "0b7c606d5685ed09a5d5694505fa4db0baed6f46",
"data": {"user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"email": "titan@nordantech.com",
"password_modified_time": "2022-06-27T09:48:05.000000Z",
"password_age": 1,
"password_age_relative_time": "yesterday",
"password_update": false,
"login_confirmation": false,
"locale": 1,
"language": 1,
"intercom": "3b9a556c35aaf1d710b7dd5d6749bb682ca67a87c68f5aac4f4496fae6d7da21",
"onboarding": false,
"state": "{\"dashboard\":{\"idSeed\":5,\"items\":[{\"type\":\"dashboardeffectsoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardeffectsoverviewwidget1\",\"columnIndex\":0},{\"type\":\"dashboardeffectsscorewidget\",\"id\":\"dashboardhome-1120_dashboardeffectsscorewidget2\",\"columnIndex\":0},{\"type\":\"dashboardscheduleoverviewwidget\",\"id\":\"dashboardhome-1120_dashboardscheduleoverviewwidget3\",\"columnIndex\":1},{\"type\":\"dashboardschedulescorewidget\",\"id\":\"dashboardhome-1120_dashboardschedulescorewidget4\",\"columnIndex\":1}],\"columnWidths\":[0.5,0.5]},\"dashboardeffectsoverviewwidget\":{\"height\":410},\"dashboardscheduleoverviewwidget\":{\"height\":410},\"dashboardeffectsscorewidget\":{\"height\":200},\"dashboardschedulescorewidget\":{\"height\":200}}",
"registration_time": "2019-11-14T16:07:39.000000Z",
"terms_accepted_time": "2019-11-14T16:07:39.000000Z",
"terms_reconfirmation": false,
"status": 1,
"model": "User",
"image": {"id": 1,
"hash": "613e66e4f1e3ef01a93cac169b75d4d9f43a8de4",
"extension": "jpg",
"mime": "image/jpeg",
"created_time": "2022-05-18T09:04:39.000000Z",
"modified_time": "2022-05-18T09:04:39.000000Z",
"modified_user_time": "2022-05-18T09:04:39.000000Z",
"model": "Image"
},
"hubs": [{"id": 1,
"hash": "1daa7da5ba074972eb3d4552414928f5201541f3",
"name": "Nordantech",
"trial": true,
"expiration_time": "2023-06-03T23:59:59.000000Z",
"remaining_days": 355,
"remaining_time": "355 days",
"model": "Hub"
},
{"id": 2,
"hash": "9f7c05fde1b7740a7dae3cc605ac360c796eb2c4",
"name": "Falcon",
"trial": true,
"expiration_time": "2022-07-13T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 days",
"model": "Hub"
}
]
},
"hub": {"id": 1,
"hash": "1ff203f04def3d63d77cb9e212ecabca04a637ca",
"name": "Nordantech",
"trial": true,
"expiration_time": "2022-06-30T23:59:59.000000Z",
"remaining_days": 30,
"remaining_time": "30 Tage",
"model": "Hub"
},
"role": 5,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJmYWxjb24uYmFja2VuZCIsImp0aSI6IjFkZDI1ZjNlYjQwYzU5YWIyNTgzMTUzZDQ0YzdmMDU1MDk1OTAzOGIiLCJuYmYiOjE2NTUxOTU0ODkuMTE2MDA1LCJpYXQiOjE2NTUxOTU0ODkuMTE2MDI0LCJleHAiOjE2ODYyOTk0ODkuMTEzMTg1LCJ0dGwiOjQzMjAwLCJzdWIiOiJmMGNjM2U2MmQ4MDgxNzZlMzYyYTFmNGU0Yzc0YjY1NjA4Njg2OWY1IiwiaHN1IjoiNWFkOTYyMmJiYTk5ZDY4ZmI1ZTY3MjhiZjY1MTI0YWFhM2EzZTMxMSIsInNlcyI6NDksImh1YiI6MSwibWZhIjpudWxsLCJzY3AiOiIqIn0.qSOVtLAmRjy1YxZKnUrRLKPN2KS4ZUIJinMZg5iHSWvRraa-6uG2A01t-LCPP-T_Ajlb_iFEUDz3jhYnsumWKA",
"ttl": 30,
"session": {"id": 54906,
"hash": "25e0e7d4a5167e0c7ff19471f767fbf77a87623f",
"model": "UserSession"
}
},
"timestamp": 1656510275631
}

➔ Next to Activation