Login
Starting with Version 1.21.1 Login with POST Method is provided. GET Login is now deprecated
Within the HTTP Response Header and the Response Body the following parameter is returned:
"X-Auth-Token": "wd8DTO5ygm0pgUaPBpNBJZz2U-WrZzDqs7OBhCpXTEw1rTHwFtw_CS92aBrQsYAsFuB..."
Hand over the corresponding parameter in the http header for all api calls. The token is valid for 24 hours or will expire if the Workflow services are restarted.
Please refer to our FAQ if Login is not working.
POST /api/v2/login1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | logoutID optional | logoutID | string |
| Body | password required | password | string |
| Body | username required | username | string |
2. Responses
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | userId optional | userId | string |
| Body | username required | username | string |
| Body | X-Auth-Token required | Token | string |
| Header |
X-Auth-Token required |
Token |
string |
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserAccountApi |
| 401 | Unauthorized | No Content |
| 403 | Forbidden | No Content |
| 404 | Not Found | No Content |
3. Produces
*/*4. Tags
login-controller-api
5. Example HTTP request Login
Request path
/api/v2/loginRequest Body
{
"username": "user",
"password": "pass"
}6. Example HTTP response Login
Response 200
{
"userId": 5,
"username": "user",
"X-Auth-Token": "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE3NTkzMDA3M......"
}To ensure encrypted password exchange do not use GET Login Method.
Within the HTTP Response Header the following parameter is returned:
"x-auth-token": "wd8DTO5ygm0pgUaPBpNBJZz2U-WrZzDqs7OBhCpXTEw1rTHwFtw_CS92aBrQsYAsFuB..."
Hand over the corresponding parameter in the http header for all api calls. The token is valid for 24 hours or will expire if the Workflow services are restarted.
Please refer to our FAQ if Login is not working.
GET /api/v1/login1. Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | logoutID optional | logoutID | string |
| Query | password required | password | string |
| Query | username required | username | string |
| Body | activeUntil optional | Date defined how long user account will be active. Must be defined in Workflow. If parameter is not listed, user account is active for unlimited time. | string (date) |
2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | UserAccountApi |
| 401 | Unauthorized | No Content |
| 403 | Forbidden | No Content |
| 404 | Not Found | No Content |
3. Produces
*/*4. Tags
login-controller-api
5. Example HTTP request Login
Request path
/api/v1/login?password=string&username=string6. Example HTTP response Login
Response 200
{
"id": 5,
"username": "username",
"activeUntil": "2038-01-19"
}