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 new user.

access
boolean
Default: false

The access of the new user.

Responses
201

Successful operation

422

Unprocessable Content

post/user
Request samples
application/json
{
  • "email": "titan@nordantech.com",
  • "access": true
}
Response samples
application/json
{
  • "success": true,
  • "hash": "5f105011c290e117f34134b19cabcc4dd06dd441",
  • "data": {
    },
  • "timestamp": 1651675897000
}

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.

Responses
200

Successful operation

422

Unprocessable Content

get/user
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "88edf5a107033a8bc38a5020b9b377d44c3514e1",
  • "data": [
    ],
  • "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
Response samples
application/json
{
  • "success": true,
  • "hash": "196da89a01df91329217060d197473d289ca471c",
  • "data": {
    },
  • "timestamp": 1661337843347
}

Update current user

Update 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.

Request Body schema: application/json

A JSON object containing user information.

name
string <= 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

The user position.

department
string

The user department.

organization
string

The user organization.

email
string <email>

The user email.

email_reports
boolean

The email reports flag for the user.

alias
string

The user alias name.

mobile
string <mobile>

The user mobile number.

login_confirmation
boolean

The login confirmation flag indicates whether the user has enabled multi factor 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
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": {
    },
  • "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

401

Unauthorized

delete/user/{user}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1661339745532
}

Upload an avatar

Upload an avatar.

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 avatar 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
Response samples
application/json
{
  • "success": true,
  • "hash": "34c3e57cf9b991d468bd8cf8114582bc4941df3e",
  • "data": {
    },
  • "timestamp": 1662132431064
}

Delete an avatar

Delete an avatar.

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
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_hash
required
string

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 hash the request will always return a 403 Forbidden response.

finished
boolean
Default: false

Include all finished activities.

Responses
200

Successful operation

422

Unprocessable Content

put/user/{user}/replace
Request samples
application/json
{
  • "user_hash": "string",
  • "finished": false
}
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1661340111804
}