POST/v1/auth/loginPOST /v1/auth/login
Code samples
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.LoginRequest | false | The 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
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.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
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| request | query | Management.GetLoggedInUserRequest | false | The 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
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.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
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.UpdateUserSettingsRequest | false | The 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
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.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
cURL
# 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
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | Management.LogoutRequest | false | none |
Example responses
200 Response
{"success":true,"code":0,"message":"string"}{
"success": true,
"code": 0,
"message": "string"
}Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Management.LogoutResponse |
Warning: To perform this operation, you must be authenticated by means of one of the following methods: Bearer & ApiKey