User API specification (908ff14c111cb267e534093ad61bc27758038e8c)
Download OpenAPI specification:
The user service is used to configure and manage users.
Login
Handles the user login and returns a user payload with JWT token
Request Body schema: application/x-www-form-urlencodedrequired
| email required | string The email for this account |
| password required | string The password for this account |
| mfa | string The user's current mfa code. This code is required if the user enabled mfa for his account, otherwise it can be left empty. To figure out if the user has mfa enabled, you need to login with username and password first. A http 401 error containing "MFA required" allows you to ask the user a current mfa code. Sending username and password again with the mfa code will finalize the login. |
Responses
Response samples
- 200
{- "active": true,
- "availablePreference": true,
- "avatarURL": "string",
- "chatToken": "string",
- "editable": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "registrationDate": null,
- "surname": "string",
- "token": "string"
}Returns a list of user sessions.
Authorizations:
query Parameters
| limit | integer [ 1 .. 50 ] Default: 10 max. amount of entries in list |
| offset | integer Default: 0 amount of entries to skip |
Responses
Response samples
- 200
{- "tokens": [
- {
- "creationTime": null,
- "id": 0,
- "ipAddress": "string",
- "isExpired": true,
- "sequence": 0,
- "sequenceMinimum": 0,
- "usageTime": null,
- "userAgent": "string",
- "userID": 0
}
], - "total": 0
}Create a change request for the email-address of your personal user account.
Must include the new email-address and a current mfa-code if mfa is enabled.
Authorizations:
Request Body schema: application/jsonrequired
| mfaCode | string current mfa-code is required if mfa is enabled for the user's account |
| newEmail required | string new email-address for the user's account |
| userID | integer <int64> optional userID of a standalone-user associated with the new email |
Responses
Request samples
- Payload
{- "mfaCode": "string",
- "newEmail": "string",
- "userID": 0
}SetInvitationText
Set the organization's invitation text configuration
Authorizations:
path Parameters
| organizationID required | integer organization by it's ID |
Request Body schema: application/jsonrequired
| organization_id | integer <int64> |
| text | string |
Responses
Request samples
- Payload
{- "organization_id": 0,
- "text": "string"
}MFAIsActive
Check if the current user has MFA enabled or not
Authorizations:
query Parameters
| organization | integer id of the organization. This is required if the user is queried |
| user | integer id of the user |
Responses
Response samples
- 200
{- "enabled": true
}GetUser
Gets the complete user payload from the passed JWT token
Authorizations:
Responses
Response samples
- 200
{- "active": true,
- "availablePreference": true,
- "avatarURL": "string",
- "chatToken": "string",
- "editable": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "registrationDate": null,
- "surname": "string",
- "token": "string"
}UpdateUser
Updates the user profile
Authorizations:
Request Body schema: application/jsonrequired
passed user update payload with new user preferences
| organizationId | integer <int64> id of the editing organization not needed if user is editing himself |
required | object (User) User is the comprehensive data structure containing all data of a single user |
Responses
Request samples
- Payload
{- "organizationId": 0,
- "user": {
- "active": true,
- "availablePreference": true,
- "avatarURL": "string",
- "chatToken": "string",
- "editable": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "registrationDate": null,
- "surname": "string",
- "token": "string"
}
}InviteUser
Invites an existing or new user to an organization and sends an invitation email to the passed address
Authorizations:
Request Body schema: application/jsonrequired
invitation payload
| createNewLabels | boolean If set to true while importing a user with a label name but not an id, we will automatically create and assign this label. This setting will only work in conjunction with MapLabelsByName. |
| mapLabelsByName | boolean If set to true while importing a user with a label name but not an id, we will try to find a label with this name and assign it. |
required | object (Organization) Organization defines an organization payload |
| removeAssignedData | boolean If set to true, all assigned data will be removed from the user, before new data is assigned. |
| updateExistingUsers | boolean If set to true, existing users will be updated with the new data. If set to false, existing users will not be updated. If set to false und the user is already in the organization, the user will be skipped and an error will be returned. |
required | Array of objects (BulkUserElement) array of user bulk elements |
Responses
Request samples
- Payload
{- "createNewLabels": true,
- "mapLabelsByName": true,
- "organization": {
- "id": 0,
- "name": "string"
}, - "removeAssignedData": true,
- "updateExistingUsers": true,
- "users": [
- {
- "devices": {
- "emails": [
- {
- "active": true,
- "email": "string",
- "name": "string",
- "ownerID": 0
}
], - "mobiles": [
- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
], - "phones": [
- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
]
}, - "email": "string",
- "externalID": "string",
- "id": 0,
- "labels": [
- {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0
}
], - "language": "string",
- "name": "string",
- "rank": {
- "name": "string",
- "value": "string"
}, - "roles": [
- null
], - "surname": "string"
}
]
}Response samples
- 200
[- {
- "importResult": "string",
- "user": {
- "devices": {
- "emails": [
- {
- "active": true,
- "email": "string",
- "name": "string",
- "ownerID": 0
}
], - "mobiles": [
- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
], - "phones": [
- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
]
}, - "email": "string",
- "externalID": "string",
- "id": 0,
- "labels": [
- {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0
}
], - "language": "string",
- "name": "string",
- "rank": {
- "name": "string",
- "value": "string"
}, - "roles": [
- null
], - "surname": "string"
}
}
]InviteOwner
Invite the passed owner to the organization
Authorizations:
Request Body schema: application/jsonrequired
owner invite payload
| organizationID | integer <int64> |
| ownerID | integer <int64> |
Responses
Request samples
- Payload
{- "organizationID": 0,
- "ownerID": 0
}ResendInvitation
Resends the invitation email of an existing user to an organization
Authorizations:
Request Body schema: application/jsonrequired
invitation payload
| createNewLabels | boolean If set to true while importing a user with a label name but not an id, we will automatically create and assign this label. This setting will only work in conjunction with MapLabelsByName. |
| mapLabelsByName | boolean If set to true while importing a user with a label name but not an id, we will try to find a label with this name and assign it. |
required | object (Organization) Organization defines an organization payload |
| removeAssignedData | boolean If set to true, all assigned data will be removed from the user, before new data is assigned. |
| updateExistingUsers | boolean If set to true, existing users will be updated with the new data. If set to false, existing users will not be updated. If set to false und the user is already in the organization, the user will be skipped and an error will be returned. |
required | Array of objects (BulkUserElement) array of user bulk elements |
Responses
Request samples
- Payload
{- "createNewLabels": true,
- "mapLabelsByName": true,
- "organization": {
- "id": 0,
- "name": "string"
}, - "removeAssignedData": true,
- "updateExistingUsers": true,
- "users": [
- {
- "devices": {
- "emails": [
- {
- "active": true,
- "email": "string",
- "name": "string",
- "ownerID": 0
}
], - "mobiles": [
- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
], - "phones": [
- {
- "active": true,
- "gsm": "string",
- "name": "string",
- "ownerID": 0
}
]
}, - "email": "string",
- "externalID": "string",
- "id": 0,
- "labels": [
- {
- "assignees": [
- 0
], - "color": "string",
- "description": "string",
- "id": 0,
- "name": "string",
- "organizationID": 0
}
], - "language": "string",
- "name": "string",
- "rank": {
- "name": "string",
- "value": "string"
}, - "roles": [
- null
], - "surname": "string"
}
]
}GetSpecificUser
Returns a specific user with the passed api for organization members
Authorizations:
path Parameters
| userID required | integer ID of an user |
query Parameters
| organization required | integer ID of the organization |
Responses
Response samples
- 200
{- "active": true,
- "availablePreference": true,
- "avatarURL": "string",
- "chatToken": "string",
- "editable": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "registrationDate": null,
- "surname": "string",
- "token": "string"
}GetDeploymentNotification
Returns the deployment notification configuration for the given user
Authorizations:
path Parameters
| userID required | integer user by his ID |
Responses
Response samples
- 200
{- "emails": [
- "string"
], - "enabled": true,
- "notificationText": "string",
- "userID": 0
}UpsertDeploymentNotification
Creates or updates a user deployment notification for the given user
Authorizations:
path Parameters
| userID required | integer user by his ID |
Request Body schema: application/jsonrequired
| emails | Array of strings |
| enabled | boolean |
| notificationText | string |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "emails": [
- "string"
], - "enabled": true,
- "notificationText": "string",
- "userID": 0
}GetSettings
Get the current user's saved settings or the default settings if none are found
Authorizations:
Responses
Response samples
- 200
{- "checks": [
- "string"
], - "dashboardConfigurations": {
- "property1": {
- "quickActions": {
- "property1": true,
- "property2": true
}
}, - "property2": {
- "quickActions": {
- "property1": true,
- "property2": true
}
}
}, - "defaultOrganizationId": 0,
- "helpTexts": [
- "string"
], - "hideExpiredTrial": true,
- "language": "string",
- "setupCurrentPath": "string",
- "setupDone": true,
- "setupOrganizationID": 0,
- "showFeedbackButton": true,
- "tableConfigurations": {
- "property1": {
- "activeColumns": [
- "string"
], - "orderByColumn": "string",
- "orderByDirection": "string",
- "pageSize": 0
}, - "property2": {
- "activeColumns": [
- "string"
], - "orderByColumn": "string",
- "orderByDirection": "string",
- "pageSize": 0
}
}, - "theme": "string",
- "tracking": true
}StoreSettings
Saves the current user's settings
Authorizations:
Request Body schema: application/jsonrequired
| checks | Array of strings |
object | |
| defaultOrganizationId | integer <int64> |
| helpTexts | Array of strings |
| hideExpiredTrial | boolean |
| language | string |
| setupCurrentPath | string |
| setupDone | boolean |
| setupOrganizationID | integer <int64> |
| showFeedbackButton | boolean |
object | |
| theme | string |
| tracking | boolean |
Responses
Request samples
- Payload
{- "checks": [
- "string"
], - "dashboardConfigurations": {
- "property1": {
- "quickActions": {
- "property1": true,
- "property2": true
}
}, - "property2": {
- "quickActions": {
- "property1": true,
- "property2": true
}
}
}, - "defaultOrganizationId": 0,
- "helpTexts": [
- "string"
], - "hideExpiredTrial": true,
- "language": "string",
- "setupCurrentPath": "string",
- "setupDone": true,
- "setupOrganizationID": 0,
- "showFeedbackButton": true,
- "tableConfigurations": {
- "property1": {
- "activeColumns": [
- "string"
], - "orderByColumn": "string",
- "orderByDirection": "string",
- "pageSize": 0
}, - "property2": {
- "activeColumns": [
- "string"
], - "orderByColumn": "string",
- "orderByDirection": "string",
- "pageSize": 0
}
}, - "theme": "string",
- "tracking": true
}Immediately sets the current user's global or organization-wide availability.
Authorizations:
Request Body schema: application/jsonrequired
| organizationID | integer <int64> |
| preference | boolean |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "organizationID": 0,
- "preference": true,
- "userID": 0
}RemoveUserOrganizationAvailability
Immediately removes the current user's organization-wide availability override. Afterwards the organization will return to using the user's global availability. If there are scheduled availability changes for the user in this organization, they will be kept and executed as planned.
Authorizations:
query Parameters
| organization_id required | integer |
Responses
AddUserAvailabilityChange
Add a new availability change for the current user or update an existing one
Authorizations:
Request Body schema: application/jsonrequired
| duration | integer <int64> |
| start_time | any |
| user_id | integer <int64> |
Responses
Request samples
- Payload
{- "duration": 0,
- "start_time": null,
- "user_id": 0
}Response samples
- 201
{- "duration": 0,
- "start_time": null,
- "user_id": 0
}GetUsersInOrganization
Returns all users from an organization
Authorizations:
query Parameters
| organization required | integer organization by it's ID |
Responses
Response samples
- 200
[- {
- "availablePreference": true,
- "availableStatus": null,
- "avatarURL": "string",
- "editable": true,
- "email": "string",
- "externalID": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "surname": "string"
}
]GetUsersInOrganizationPagination
Returns all users from an organization with pagination
Authorizations:
query Parameters
| organization required | integer organization by it's ID |
| search | string search query to filter user by name, surname or email |
| limit | integer [ 1 .. 50 ] Default: 10 max. amount of entries in list |
| offset | integer Default: 0 amount of entries to skip |
| orderby | string Default: "sur_name" Enum: "sur_name" "name" order query by column (either sur_name or name, defaults to sur_name) |
| orderdir | string Default: "asc" Enum: "asc" "desc" order direction of orderby (either asc or desc, defaults to asc) |
Responses
Response samples
- 200
[- {
- "publicUsers": [
- {
- "availablePreference": true,
- "availableStatus": null,
- "avatarURL": "string",
- "editable": true,
- "email": "string",
- "externalID": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "surname": "string"
}
], - "totalPublicUsers": 0
}
]ListRecurringAvailabilityChanges
Returns a list of all recurring availability changes created by the current user
Authorizations:
query Parameters
| limit | integer [ 1 .. 50 ] Default: 10 max. amount of entries in list |
| offset | integer Default: 0 amount of entries to skip |
| organization | integer Default: 0 id of an organization |
Responses
Response samples
- 200
{- "entries": [
- {
- "active": true,
- "changeDay": null,
- "changeStatus": "string",
- "changeTime": "string",
- "id": 0,
- "organizationID": 0,
- "userID": 0
}
], - "total": 0
}CreateRecurringAvailabilityChange
Create a new recurring availability change for the current user
Authorizations:
Request Body schema: application/jsonrequired
| active | boolean |
| changeDay | any ChangeDay is the integer description of the day in the week when a change should occur. Sunday = 0, Monday = 1, ... |
| changeStatus | string (UserAvailabilityStatus) UserAvailabilityStatus represents the new status a user should be in after processing a change request |
| changeTime | string ChangeTime it the UTC time when a change should occur, formatted as "15:04:05". |
| id | integer <int64> |
| organizationID | integer <int64> |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "active": true,
- "changeDay": null,
- "changeStatus": "string",
- "changeTime": "string",
- "id": 0,
- "organizationID": 0,
- "userID": 0
}Response samples
- 201
{- "active": true,
- "changeDay": null,
- "changeStatus": "string",
- "changeTime": "string",
- "id": 0,
- "organizationID": 0,
- "userID": 0
}UpdateRecurringAvailabilityChange
Updates an existing recurring availability change for the current user
Authorizations:
path Parameters
| changeID required | integer |
Request Body schema: application/jsonrequired
| active | boolean |
| changeDay | any ChangeDay is the integer description of the day in the week when a change should occur. Sunday = 0, Monday = 1, ... |
| changeStatus | string (UserAvailabilityStatus) UserAvailabilityStatus represents the new status a user should be in after processing a change request |
| changeTime | string ChangeTime it the UTC time when a change should occur, formatted as "15:04:05". |
| id | integer <int64> |
| organizationID | integer <int64> |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "active": true,
- "changeDay": null,
- "changeStatus": "string",
- "changeTime": "string",
- "id": 0,
- "organizationID": 0,
- "userID": 0
}Response samples
- 200
{- "active": true,
- "changeDay": null,
- "changeStatus": "string",
- "changeTime": "string",
- "id": 0,
- "organizationID": 0,
- "userID": 0
}ListScheduledAvailabilityChanges
Returns a list of all scheduled availability changes created by the current user
Authorizations:
query Parameters
| limit | integer [ 1 .. 50 ] Default: 10 max. amount of entries in list |
| offset | integer Default: 0 amount of entries to skip |
Responses
Response samples
- 200
{- "entries": [
- {
- "changeStatus": "string",
- "changeTime": null,
- "id": 0,
- "userID": 0
}
], - "total": 0
}CreateScheduledAvailabilityChange
Create a new scheduled availability change for the current user
Authorizations:
Request Body schema: application/jsonrequired
| changeStatus | string (UserAvailabilityStatus) UserAvailabilityStatus represents the new status a user should be in after processing a change request |
| changeTime | any |
| id | integer <int64> |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "changeStatus": "string",
- "changeTime": null,
- "id": 0,
- "userID": 0
}Response samples
- 201
{- "changeStatus": "string",
- "changeTime": null,
- "id": 0,
- "userID": 0
}