Skip to Content
New release 11.5 available 🎉
API ReferenceAuthentication

POST/v1/auth/loginPOST /v1/auth/login

Code samples

# You can also use wget curl -X POST /v1/auth/login \ -H 'Content-Type: application/json-patch+json' \ -H 'Accept: text/plain' \ -H 'x-api-key: API_KEY'

POST /v1/auth/login

Login to the system.

Body parameter

{ "username": "string", "password": "string" }

Parameters

NameInTypeRequiredDescription
bodybodyManagement.LoginRequestfalseThe login request.

Example responses

200 Response

{"success":true,"code":0,"message":"string","token":"string","expiresIn":0}
{ "success": true, "code": 0, "message": "string", "token": "string", "expiresIn": 0 }

Responses

StatusMeaningDescriptionSchema
200OK OKManagement.LoginResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

GET/v1/auth/userGET /v1/auth/user

Code samples

# You can also use wget curl -X GET /v1/auth/user \ -H 'Accept: text/plain' \ -H 'x-api-key: API_KEY'

GET /v1/auth/user

Get loggedin user information.

Parameters

NameInTypeRequiredDescription
requestqueryManagement.GetLoggedInUserRequestfalseThe logged in user request.

Example responses

200 Response

{"success":true,"code":0,"message":"string","user":{"id":"string","userName":"string","email":"string","phoneNumber":"string","title":"string","firstName":"string","lastName":"string","department":"string","birthDate":"2019-08-24T14:15:22Z","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","lastDismissMessages":"2019-08-24T14:15:22Z","lastLogIn":"2019-08-24T14:15:22Z","rank":0,"image":"string","address":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mobile":"string","notes":"string","customerId":0,"roles":["string"],"apiKeys":[{"id":0,"name":"string","key":"string","clientSecret":"string","createdDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","ownerId":"string","revoked":true,"permissions":0,"description":"string"}],"settings":[{"id":0,"category":"string","group":"string","name":"string","value":"string","type":"string","description":"string","readOnly":true,"userId":"string"}]}}
{ "success": true, "code": 0, "message": "string", "user": { "id": "string", "userName": "string", "email": "string", "phoneNumber": "string", "title": "string", "firstName": "string", "lastName": "string", "department": "string", "birthDate": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "lastDismissMessages": "2019-08-24T14:15:22Z", "lastLogIn": "2019-08-24T14:15:22Z", "rank": 0, "image": "string", "address": "string", "postalCode": "string", "region": "string", "city": "string", "country": "string", "countryCode": "string", "mobile": "string", "notes": "string", "customerId": 0, "roles": [ "string" ], "apiKeys": [ { "id": 0, "name": "string", "key": "string", "clientSecret": "string", "createdDate": "2019-08-24T14:15:22Z", "expireDate": "2019-08-24T14:15:22Z", "ownerId": "string", "revoked": true, "permissions": 0, "description": "string" } ], "settings": [ { "id": 0, "category": "string", "group": "string", "name": "string", "value": "string", "type": "string", "description": "string", "readOnly": true, "userId": "string" } ] } }

Responses

StatusMeaningDescriptionSchema
200OK OKManagement.GetLoggedInUserResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST/v1/auth/userPOST /v1/auth/user

Code samples

# You can also use wget curl -X POST /v1/auth/user \ -H 'Content-Type: application/json-patch+json' \ -H 'Accept: text/plain' \ -H 'x-api-key: API_KEY'

POST /v1/auth/user

Update loggedin user information.

Body parameter

{ "user": { "id": "string", "userName": "string", "email": "string", "phoneNumber": "string", "title": "string", "firstName": "string", "lastName": "string", "department": "string", "birthDate": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "lastDismissMessages": "2019-08-24T14:15:22Z", "lastLogIn": "2019-08-24T14:15:22Z", "rank": 0, "image": "string", "address": "string", "postalCode": "string", "region": "string", "city": "string", "country": "string", "countryCode": "string", "mobile": "string", "notes": "string", "customerId": 0, "roles": [ "string" ], "apiKeys": [ { "id": 0, "name": "string", "key": "string", "clientSecret": "string", "createdDate": "2019-08-24T14:15:22Z", "expireDate": "2019-08-24T14:15:22Z", "ownerId": "string", "revoked": true, "permissions": 0, "description": "string" } ], "settings": [ { "id": 0, "category": "string", "group": "string", "name": "string", "value": "string", "type": "string", "description": "string", "readOnly": true, "userId": "string" } ] } }

Parameters

NameInTypeRequiredDescription
bodybodyManagement.UpdateUserSettingsRequestfalseThe logged in user information request.

Example responses

200 Response

{"success":true,"code":0,"message":"string","user":{"id":"string","userName":"string","email":"string","phoneNumber":"string","title":"string","firstName":"string","lastName":"string","department":"string","birthDate":"2019-08-24T14:15:22Z","createdAt":"2019-08-24T14:15:22Z","updatedAt":"2019-08-24T14:15:22Z","lastDismissMessages":"2019-08-24T14:15:22Z","lastLogIn":"2019-08-24T14:15:22Z","rank":0,"image":"string","address":"string","postalCode":"string","region":"string","city":"string","country":"string","countryCode":"string","mobile":"string","notes":"string","customerId":0,"roles":["string"],"apiKeys":[{"id":0,"name":"string","key":"string","clientSecret":"string","createdDate":"2019-08-24T14:15:22Z","expireDate":"2019-08-24T14:15:22Z","ownerId":"string","revoked":true,"permissions":0,"description":"string"}],"settings":[{"id":0,"category":"string","group":"string","name":"string","value":"string","type":"string","description":"string","readOnly":true,"userId":"string"}]}}
{ "success": true, "code": 0, "message": "string", "user": { "id": "string", "userName": "string", "email": "string", "phoneNumber": "string", "title": "string", "firstName": "string", "lastName": "string", "department": "string", "birthDate": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "lastDismissMessages": "2019-08-24T14:15:22Z", "lastLogIn": "2019-08-24T14:15:22Z", "rank": 0, "image": "string", "address": "string", "postalCode": "string", "region": "string", "city": "string", "country": "string", "countryCode": "string", "mobile": "string", "notes": "string", "customerId": 0, "roles": [ "string" ], "apiKeys": [ { "id": 0, "name": "string", "key": "string", "clientSecret": "string", "createdDate": "2019-08-24T14:15:22Z", "expireDate": "2019-08-24T14:15:22Z", "ownerId": "string", "revoked": true, "permissions": 0, "description": "string" } ], "settings": [ { "id": 0, "category": "string", "group": "string", "name": "string", "value": "string", "type": "string", "description": "string", "readOnly": true, "userId": "string" } ] } }

Responses

StatusMeaningDescriptionSchema
200OK OKManagement.UpdateUserSettingsResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

POST/v1/auth/logoutPOST /v1/auth/logout

Code samples

# You can also use wget curl -X POST /v1/auth/logout \ -H 'Content-Type: application/json-patch+json' \ -H 'Accept: text/plain' \ -H 'x-api-key: API_KEY'

POST /v1/auth/logout

Logout from the system.

Body parameter

{}

Parameters

NameInTypeRequiredDescription
bodybodyManagement.LogoutRequestfalsenone

Example responses

200 Response

{"success":true,"code":0,"message":"string"}
{ "success": true, "code": 0, "message": "string" }

Responses

StatusMeaningDescriptionSchema
200OK OKManagement.LogoutResponse

Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey

Last updated on