Download OpenAPI specification:Download
The user service implements all user functions for GroupAlarm.
To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | API-TOKEN |
To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token
for every request, otherwise the API will return an "401 Unauthorized" error for your request.
Security Scheme Type | API Key |
---|---|
Header parameter name: | Personal-Access-Token |
Handles the user login and returns a user payload with JWT token
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. |
{- "active": true,
- "availablePreference": true,
- "avatarURL": "string",
- "chatToken": "string",
- "editable": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "registrationDate": null,
- "surname": "string",
- "token": "string"
}
limit | integer [ 1 .. 50 ] Default: 10 max. amount of entries in list |
offset | integer Default: 0 amount of entries to skip |
{- "tokens": [
- {
- "creationTime": null,
- "id": 0,
- "ipAddress": "string",
- "isExpired": true,
- "sequence": 0,
- "sequenceMinimum": 0,
- "usageTime": null,
- "userAgent": "string",
- "userID": 0
}
], - "total": 0
}
Must include the new email-address and a current mfa-code if mfa is enabled.
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 |
{- "mfaCode": "string",
- "newEmail": "string",
- "userID": 0
}
Set the organization's invitation text configuration
organizationID required | integer organization by it's ID |
organization_id | integer <int64> |
text | string |
{- "organization_id": 0,
- "text": "string"
}
{- "active": true,
- "availablePreference": true,
- "avatarURL": "string",
- "chatToken": "string",
- "editable": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "pending": true,
- "registrationDate": null,
- "surname": "string",
- "token": "string"
}
Updates the user profile
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 |
{- "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"
}
}
Invites an existing or new user to an organization and sends an invitation email to the passed address
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 |
required | Array of objects (BulkUserElement) [ items ] array of user bulk elements |
{- "createNewLabels": true,
- "mapLabelsByName": true,
- "organization": {
- "id": 0,
- "name": "string"
}, - "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",
- "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"
}
]
}
[- {
- "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",
- "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"
}
}
]
Resends the invitation email of an existing user to an organization
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 |
required | Array of objects (BulkUserElement) [ items ] array of user bulk elements |