User

The user.

Create a user

Create a new user.

SecurityJWT

Request

Request Body schema: application/json

A JSON object containing user information.

email required	string <email> The email of the user.
access	boolean Default: false The access of the user.

Responses

200

Successful operation

201

Successful operation

422

Unprocessable Content

post/user

Request samples

Payload
curl

application/json

{"email": "titan@nordantech.com",
"access": true
}

Response samples

application/json

{"success": true,
"hash": "4f8036f4218eda08b797f832fb1c2616c92dbbe5",
"data": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "titan@nordantech.com",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"domain": "nordantech.com",
"password_modified_time": "2022-05-04T16:51:37.000000Z",
"password_age": 0,
"password_age_relative_time": "just now",
"login_confirmation_channel": 1,
"language": 0,
"settings": {"email_reports": true,
"login_confirmation": false,
"locale": 0
},
"status": 2,
"model": "User",
"user_invitation": null,
"user_hub_permission": {"hash": "77d545db7db581a9040bb084463ef2a8f3d0bf49",
"umask": 1,
"created_time": "2024-03-19T11:06:43.000000Z",
"modified_time": "2024-03-19T11:06:43.000000Z",
"modified_user_time": "2024-03-19T11:06:43.000000Z",
"model": "UserHubPermission"
}
},
"timestamp": 1710846404017
}

Get all users

Get all users of the authenticated hub.

SecurityJWT

Request

query Parameters

measure	string or integer Filter the user list for a measure.
measure_package	string or integer Filter the user list for a measure package.
project	string or integer Filter the user list for a project.
program	string or integer Filter the user list for a program.
page	integer Default: 1 The page number of the response.

Responses

200

Successful operation

422

Unprocessable Content

get/user

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "88edf5a107033a8bc38a5020b9b377d44c3514e1",
"data": [{"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"domain": "nordantech.com",
"password_modified_time": "2022-05-04T16:51:37.000000Z",
"password_age": 0,
"password_age_relative_time": "50 minutes ago",
"login_time": "2022-08-23T15:34:23.000000Z",
"login_confirmation_channel": 1,
"language": 0,
"settings": {"email_reports": true,
"login_confirmation": false,
"locale": 0
},
"status": 1,
"model": "User",
"image": null,
"user_invitation": null,
"user_hub_permission": {"hash": "60d5d8b00cc525536e03a43c6845da87616c4540",
"umask": 4,
"created_time": "2022-06-27T09:48:05.000000Z",
"modified_time": "2022-06-27T09:48:05.000000Z",
"modified_user_time": "2022-06-27T09:48:05.000000Z",
"model": "UserHubPermission"
}
},
{"id": 2,
"hash": "a13b1b362d914d12bbcf5de981e3a7f53d00a8d0",
"name": "Uli Hoeneß",
"first_name": "Uli",
"last_name": "Hoeneß",
"position": "CEO",
"department": "Sausage factory",
"organization": "Nordantech",
"email": "knacki@nordantech.com",
"domain": "nordantech.com",
"password_modified_time": "2022-06-27T11:03:50.000000Z",
"password_age": 57,
"password_age_relative_time": "1 month ago",
"login_time": "2022-08-22T16:10:04.000000Z",
"login_confirmation_channel": 3,
"language": 0,
"settings": {"email_reports": true,
"login_confirmation": true,
"locale": 0
},
"status": 1,
"model": "User",
"image": {"id": 2,
"hash": "7eacd79a0e9a4bd2f61c8b53f3cbba5166f73ee6",
"extension": "jpg",
"mime": "image/jpeg",
"size": 133912,
"created_time": "2022-06-29T15:34:02.000000Z",
"modified_time": "2022-08-22T10:09:17.000000Z",
"modified_user_time": "2022-06-29T15:34:02.000000Z",
"model": "Image"
},
"user_invitation": null,
"user_hub_permission": {"hash": "79cadf502e6f6b8e9b8f70fa4a24159f15efbbd0",
"umask": 1,
"created_time": "2022-06-27T11:02:43.000000Z",
"modified_time": "2022-06-27T11:02:43.000000Z",
"modified_user_time": "2022-06-27T11:02:43.000000Z",
"model": "UserHubPermission"
}
}
],
"meta": {"page": 1,
"first": 1,
"last": 2,
"total": 2,
"limit": 1000,
"pages": 1
},
"timestamp": 1661337037569
}

Get current user

Get the current user.

SecurityJWT

Request

path Parameters

user

required

string or integer

The id/hash of the current user.

The user may only perform this action on him/herself.

Responses

200

Successful operation

404

Not Found

get/user/{user}

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "196da89a01df91329217060d197473d289ca471c",
"data": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"domain": "nordantech.com",
"alias": "titan",
"mobile": "",
"password_modified_time": "2022-05-04T16:51:37.000000Z",
"password_age": 0,
"password_age_relative_time": "1 hour ago",
"login_confirmation_channel": 1,
"language": 0,
"settings": {"email_reports": true,
"login_confirmation": false,
"locale": 0
},
"status": 1,
"model": "User",
"image": null,
"user_email_verification": null,
"user_mobile_verification": null
},
"timestamp": 1661337843347
}

Update a user

Update a user.

SecurityJWT

Request

path Parameters

user

required

string or integer

The id/hash of the user.

A foreign user can only be modified as long as he/she is in user status pending. If the registration was completed successfully, the user can only edit himself/herself.

Request Body schema: application/json

A JSON object containing user information.

One of:

name	string or null <= 1000 characters The user display name.
first_name	string <= 1000 characters The user first name.
last_name	string <= 1000 characters The user last name.
position	string or null <= 1000 characters The user position.
department	string or null <= 1000 characters The user department.
organization	string or null <= 1000 characters The user organization.
email	string <email> The user email.
email_reports	boolean The email reports flag for the user.
alias	string <= 1000 characters The user alias name.
mobile	string <mobile> The user mobile number.
login_confirmation	boolean The login confirmation flag indicates whether the user must complete their login with multifactor authentication.
current_password	string The user current password.
password	string The user password.
locale	integer The locale information of the user. 0 - DE_DE 1 - EN_GB The local information is used to determine the Falcon language. It is composed of the selected language (e.g. "EN") and the origin (e.g. "GB") of the user. Enum: 0 1
onboarding	boolean The flag indicates whether the user will be shown the onboarding tutorial in Falcon when logging in.
state	string or null The frontend state of the user. Here the settings for the dashboard are stored, e.g. which widgets should be displayed where.

Responses

200

Successful operation

404

Not Found

422

Unprocessable Content

put/user/{user}

Request samples

Payload
curl

application/json

{"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email_reports": true,
"alias": "Titan"
}

Response samples

application/json

{"success": true,
"hash": "e374e0f7088bd1f76525310f13524074845c2a6c",
"data": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"domain": "nordantech.com",
"alias": "titan",
"mobile": "",
"password_modified_time": "2022-05-04T16:51:37.000000Z",
"password_age": 0,
"password_age_relative_time": "2 minutes ago",
"login_confirmation_channel": 1,
"language": 0,
"settings": {"email_reports": true,
"login_confirmation": false,
"locale": 0
},
"status": 1,
"model": "User"
},
"timestamp": 1653301097000
}

Delete current user

Delete the current user.

SecurityJWT

Request

path Parameters

user

required

string or integer

The id/hash of the current user.

The user may only perform this action on him/herself.

Responses

200

Successful operation

delete/user/{user}

Request samples

curl

Response samples

application/json

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

Upload an image

Upload an image.

SecurityJWT

Request

path Parameters

user

required

string or integer

The id/hash of the user.

Request Body schema: multipart/form-data

A JSON object containing image information.

image

required

string <binary>

The upload image.

The image must be a usable file with the mime types jpg or png. The maximum file size is 10MB. The minimum width and height of the image is 400 pixel.

Responses

200

Successful operation

422

Unprocessable Content

post/user/{user}/image

Request samples

curl

Response samples

application/json

{"success": true,
"hash": "34c3e57cf9b991d468bd8cf8114582bc4941df3e",
"data": {"id": 5,
"hash": "ee5b1b0790292a6fd7a24fcf62ad503071e6fdaf",
"extension": "png",
"mime": "image/png",
"size": 174303,
"created_time": "2022-09-02T15:27:11.000000Z",
"modified_time": "2022-09-02T15:27:11.000000Z",
"modified_user_time": "2022-09-02T15:27:11.000000Z",
"model": "Image",
"created_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-25T09:02:43.000000Z",
"modified_user_time": "2022-05-25T09:02:43.000000Z",
"model": "User"
},
"modified_user": {"id": 1,
"hash": "8db560a23013ff54838d45e59a3f3f39f6720c86",
"name": "Olli Kahn",
"first_name": "Olli",
"last_name": "Kahn",
"position": "CEO",
"department": "Engine room",
"organization": "Nordantech",
"email": "titan@nordantech.com",
"status": 1,
"created_time": "2022-05-04T16:51:37.000000Z",
"modified_time": "2022-05-25T09:02:43.000000Z",
"modified_user_time": "2022-05-25T09:02:43.000000Z",
"model": "User"
}
},
"timestamp": 1662132431064
}

Delete an image

Delete an image.

SecurityJWT

Request

path Parameters

user

required

string or integer

The id/hash of the user.

Responses

200

Successful operation

404

Not Found

delete/user/{user}/image

Request samples

curl

Response samples

application/json

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

Replace a user

Replace a user as the responsible user in all his/her activities, measures, packages, projects and programs of the authenticated hub.

SecurityJWT

Request

path Parameters

user

required

string or integer

The id/hash of the user.

Request Body schema: application/json

A JSON object containing user information.

user required	string or integer The new responsible user. This user will be used in all tree items as well as in all activities where the original user was the responsible user. Without a user the request will always return a `403 Forbidden` response.
finished	boolean Default: false Include all finished activities in the responsible user's transfer.

Responses

200

Successful operation

422

Unprocessable Content

put/user/{user}/replace

Request samples

Payload
curl

application/json

{"user": "string",
"finished": false
}

Response samples

application/json

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

➔ Next to User authenticator