Download OpenAPI specification:Download
The (OX Protect) Notification Center takes care of sending messages to users. This can be real-time security alerts as well as other security related or informal messages, based on events generated by various source like PowerDNS, Anti Abuse Shield or other sources.
Data of the new user
Array of objects (EmailAddress) [ items ] | |
locale | string The selected language of the user |
Array of objects (PhoneNumber) [ items ] | |
Array of objects (PushToken) [ items ] | |
Array of objects (UserMapping) [ items ] | |
user_id required | string [ 1 .. 50 ] characters Unique user id for notification centre |
{- "emailaddress": [
- {
- "active": true,
- "emailaddress": "string"
}
], - "locale": "string",
- "phonenumbers": [
- {
- "active": true,
- "phone_number": "string"
}
], - "pushtokens": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "userMappings": [
- {
- "app": "string",
- "user_name_in_app": "string"
}
], - "user_id": "string"
}
userId required | string The user id of the user to get |
{- "emailaddress": [
- {
- "active": true,
- "emailaddress": "string",
- "id": 0
}
], - "id": 0,
- "locale": "string",
- "phonenumbers": [
- {
- "active": true,
- "id": 0,
- "phone_number": "string"
}
], - "pushtokens": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "userMappings": [
- {
- "app": "string",
- "id": 0,
- "user_name_in_app": "string"
}
], - "user_id": "string"
}
userId required | string The current id of the user to update |
Update data for a user
locale | string The selected language of the user |
user_id | string Unique user id for notification centre |
{- "locale": "string",
- "user_id": "string"
}
{- "emailaddress": [
- {
- "active": true,
- "emailaddress": "string",
- "id": 0
}
], - "id": 0,
- "locale": "string",
- "phonenumbers": [
- {
- "active": true,
- "id": 0,
- "phone_number": "string"
}
], - "pushtokens": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "userMappings": [
- {
- "app": "string",
- "id": 0,
- "user_name_in_app": "string"
}
], - "user_id": "string"
}
userId required | string The current id of the user to update |
create | boolean Create if not exists? |
add | boolean Add and not replace notification channels? |
Update data for a user
Array of objects (EmailAddress) [ items ] | |
locale | string The selected language of the user |
Array of objects (PhoneNumber) [ items ] | |
Array of objects (PushToken) [ items ] | |
Array of objects (UserMapping) [ items ] | |
user_id required | string [ 1 .. 50 ] characters Unique user id for notification centre |
{- "emailaddress": [
- {
- "active": true,
- "emailaddress": "string"
}
], - "locale": "string",
- "phonenumbers": [
- {
- "active": true,
- "phone_number": "string"
}
], - "pushtokens": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "userMappings": [
- {
- "app": "string",
- "user_name_in_app": "string"
}
], - "user_id": "string"
}
{- "code": 0,
- "message": "string"
}
userId required | string Id of the user to create the device for |
{- "email": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}, - "push": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}, - "sms": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
}
userId required | string Id of the user to create the notificationconfiguration for |
Data of all channel configuration
object (ChannelConfiguration) The configuration for a channel to send notifications to a user. The object contains a whitelist. Each notification which has a category or code which is mentioned in configuration list will be send. If the list is empty all notifications will be send. | |
object (ChannelConfiguration) The configuration for a channel to send notifications to a user. The object contains a whitelist. Each notification which has a category or code which is mentioned in configuration list will be send. If the list is empty all notifications will be send. | |
object (ChannelConfiguration) The configuration for a channel to send notifications to a user. The object contains a whitelist. Each notification which has a category or code which is mentioned in configuration list will be send. If the list is empty all notifications will be send. |
{- "email": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}, - "push": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}, - "sms": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
}
{- "email": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}, - "push": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}, - "sms": {
- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
}
page | integer <int32> page index of paging |
size | integer <int32> size of a page in paging |
{- "elements": [
- {
- "emailaddress": [
- {
- "active": true,
- "emailaddress": "string",
- "id": 0
}
], - "id": 0,
- "locale": "string",
- "phonenumbers": [
- {
- "active": true,
- "id": 0,
- "phone_number": "string"
}
], - "pushtokens": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "userMappings": [
- {
- "app": "string",
- "id": 0,
- "user_name_in_app": "string"
}
], - "user_id": "string"
}
], - "pageCurrent": 0,
- "pageSize": 0,
- "pagesTotal": 0,
- "size": 0
}
List of new users
Array of objects (EmailAddress) [ items ] | |
locale | string The selected language of the user |
Array of objects (PhoneNumber) [ items ] | |
Array of objects (PushToken) [ items ] | |
Array of objects (UserMapping) [ items ] | |
user_id required | string [ 1 .. 50 ] characters Unique user id for notification centre |
[- {
- "emailaddress": [
- {
- "active": true,
- "emailaddress": "string"
}
], - "locale": "string",
- "phonenumbers": [
- {
- "active": true,
- "phone_number": "string"
}
], - "pushtokens": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "userMappings": [
- {
- "app": "string",
- "user_name_in_app": "string"
}
], - "user_id": "string"
}
]
List of new users
Array of objects (EmailAddress) [ items ] | |
locale | string The selected language of the user |
Array of objects (PhoneNumber) [ items ] | |
Array of objects (PushToken) [ items ] | |
Array of objects (UserMapping) [ items ] | |
user_id required | string [ 1 .. 50 ] characters Unique user id for notification centre |
[- {
- "emailaddress": [
- {
- "active": true,
- "emailaddress": "string"
}
], - "locale": "string",
- "phonenumbers": [
- {
- "active": true,
- "phone_number": "string"
}
], - "pushtokens": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "userMappings": [
- {
- "app": "string",
- "user_name_in_app": "string"
}
], - "user_id": "string"
}
]
0
Data of the new notification
app required | string The identifier of the application that generated the notification. | ||||||||||||||||
broadcast | boolean Whether the notification has been broadcasted to all users. | ||||||||||||||||
categories | Array of strings The names of all classification categories that caused to block a request. | ||||||||||||||||
code required | string Enum: "NOTIFY_INFO" "PROTECT_NOTIFY_BLOCKED_MALWARE" "PROTECT_NOTIFY_BLOCKED_FILTER_CATEGORY" "PROTECT_NOTIFY_BLOCKED_FILTER_BLACKLIST" "PROTECT_NOTIFY_NEW_DEVICE" "NOTIFY_LOGIN_SUCC" "NOTIFY_LOGIN_FAILED" "NOTIFY_LOGIN_SUSPICIOUS" Integral notification type identifier.
| ||||||||||||||||
device_id | string [ 0 .. 50 ] characters The identifier of the affected (e.g. blocked) device. Empty string if the notification does not belong to a specific device. | ||||||||||||||||
device_ip | string The IP address of the affected (e.g. blocked) device. Empty string if the notification does not belong to a specific device. | ||||||||||||||||
device_name | string The name of the new device. The value of this property will only be recognized when the code is PROTECT_NOTIFY_NEW_DEVICE. | ||||||||||||||||
device_type | string The type of the new device. The value of this property will only be recognized when the code is PROTECT_NOTIFY_NEW_DEVICE. | ||||||||||||||||
object (NotificationTokenRepresentation) | |||||||||||||||||
hidden | boolean Indicator if the notification is hidden. | ||||||||||||||||
severity | string Enum: "LOW" "MEDIUM" "HIGH" An identifier for the severity of the notification. | ||||||||||||||||
text | string An arbitrary explicit notification text to be shown to the user. | ||||||||||||||||
timestamp required | string <date-time> ISO-8601 time stamp of the notification, e.g. '2017-07-11T11:09:54' | ||||||||||||||||
url | string The URL that was blocked by a filter rule. | ||||||||||||||||
user_id required | string [ 1 .. 50 ] characters The identifier of the user owning the notification. |
{- "app": "string",
- "broadcast": true,
- "categories": [
- "string"
], - "code": "NOTIFY_INFO",
- "device_id": "string",
- "device_ip": "string",
- "device_name": "string",
- "device_type": "string",
- "excluded_push_token": {
- "provider_type": "ANDROID",
- "token": "string"
}, - "hidden": true,
- "severity": "LOW",
- "text": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "url": "string",
- "user_id": "string"
}
userId required | string Id of the user to update the notifications for |
notificationId required | string Id of the the notifications to update |
Update data for the notification
hidden | boolean Indicator if the notification is hidden. |
{- "hidden": true
}
{- "app": "string",
- "broadcast": true,
- "categories": [
- "string"
], - "code": "NOTIFY_INFO",
- "device_id": "string",
- "device_ip": "string",
- "device_name": "string",
- "device_type": "string",
- "excluded_push_token": {
- "provider_type": "ANDROID",
- "token": "string"
}, - "hidden": true,
- "id": "string",
- "severity": "LOW",
- "text": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "url": "string",
- "user_id": "string"
}
userId required | string Id of the user to get the notifications for |
page | integer <int32> page index of paging |
size | integer <int32> size of a page in paging |
sort required | string Enum: "ASC" "DESC" Sort by timestamp. Possible values are ASC(ascending) or DESC(descending) |
{- "elements": [
- {
- "app": "string",
- "broadcast": true,
- "categories": [
- "string"
], - "code": "NOTIFY_INFO",
- "device_id": "string",
- "device_ip": "string",
- "device_name": "string",
- "device_type": "string",
- "excluded_push_token": {
- "provider_type": "ANDROID",
- "token": "string"
}, - "hidden": true,
- "id": "string",
- "severity": "LOW",
- "text": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "url": "string",
- "user_id": "string"
}
], - "pageCurrent": 0,
- "pageSize": 0,
- "pagesTotal": 0,
- "size": 0
}
userId required | string Id of the user to get the notifications for |
page | integer <int32> page index of paging |
size | integer <int32> size of a page in paging |
whitelistfilter | boolean Use filter as a whitelistfilter? |
sort required | string Enum: "ASC" "DESC" Sort by timestamp. Possible values are ASC(ascending) or DESC(descending) |
Filter information
categories | Array of strings list of categories to search for |
codes | Array of strings Items Enum: "NOTIFY_INFO" "PROTECT_NOTIFY_BLOCKED_MALWARE" "PROTECT_NOTIFY_BLOCKED_FILTER_CATEGORY" "PROTECT_NOTIFY_BLOCKED_FILTER_BLACKLIST" "PROTECT_NOTIFY_NEW_DEVICE" "NOTIFY_LOGIN_SUCC" "NOTIFY_LOGIN_FAILED" "NOTIFY_LOGIN_SUSPICIOUS" list of types to search for |
deviceIds | Array of strings list of deviceIds to search for |
deviceIps | Array of strings list of deviceIps to search for |
remember_youngest_not_timestamp | boolean Remember the timestamp of the youngest notification |
show_hidden | boolean Indicator if hidden notifications should be selected. |
sites | Array of strings list of sites to search for |
object (TimePeriod) from until search |
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
], - "deviceIds": [
- "string"
], - "deviceIps": [
- "string"
], - "remember_youngest_not_timestamp": true,
- "show_hidden": true,
- "sites": [
- "string"
], - "time": {
- "from": "2017-07-11T11:09:54.000Z",
- "to": "2017-07-11T11:09:54.000Z"
}
}
{- "elements": [
- {
- "app": "string",
- "broadcast": true,
- "categories": [
- "string"
], - "code": "NOTIFY_INFO",
- "device_id": "string",
- "device_ip": "string",
- "device_name": "string",
- "device_type": "string",
- "excluded_push_token": {
- "provider_type": "ANDROID",
- "token": "string"
}, - "hidden": true,
- "id": "string",
- "severity": "LOW",
- "text": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "url": "string",
- "user_id": "string"
}
], - "pageCurrent": 0,
- "pageSize": 0,
- "pagesTotal": 0,
- "size": 0
}
userId required | string Id of the user to get the notifications for |
whitelistfilter | boolean Use filter as a whitelistfilter? |
Filter information
categories | Array of strings list of categories to search for |
codes | Array of strings Items Enum: "NOTIFY_INFO" "PROTECT_NOTIFY_BLOCKED_MALWARE" "PROTECT_NOTIFY_BLOCKED_FILTER_CATEGORY" "PROTECT_NOTIFY_BLOCKED_FILTER_BLACKLIST" "PROTECT_NOTIFY_NEW_DEVICE" "NOTIFY_LOGIN_SUCC" "NOTIFY_LOGIN_FAILED" "NOTIFY_LOGIN_SUSPICIOUS" list of types to search for |
deviceIds | Array of strings list of deviceIds to search for |
deviceIps | Array of strings list of deviceIps to search for |
remember_youngest_not_timestamp | boolean Remember the timestamp of the youngest notification |
show_hidden | boolean Indicator if hidden notifications should be selected. |
sites | Array of strings list of sites to search for |
object (TimePeriod) from until search |
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
], - "deviceIds": [
- "string"
], - "deviceIps": [
- "string"
], - "remember_youngest_not_timestamp": true,
- "show_hidden": true,
- "sites": [
- "string"
], - "time": {
- "from": "2017-07-11T11:09:54.000Z",
- "to": "2017-07-11T11:09:54.000Z"
}
}
0
userId required | string Id of the user to get the notifications for |
0
userId required | string Id of the user to get filter settings for |
withHidden | boolean With values of hidden notifications? |
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
], - "deviceIds": [
- "string"
], - "deviceIps": [
- "string"
], - "remember_youngest_not_timestamp": true,
- "show_hidden": true,
- "sites": [
- "string"
], - "time": {
- "from": "2017-07-11T11:09:54.000Z",
- "to": "2017-07-11T11:09:54.000Z"
}
}
userId required | string Id of the user to get the notifications for |
notificationIds required | string The single id or comma separated list of the notifications to get |
sort required | string Enum: "ASC" "DESC" Sort by timestamp. Possible values are ASC(ascending) or DESC(descending) |
{- "app": "string",
- "broadcast": true,
- "categories": [
- "string"
], - "code": "NOTIFY_INFO",
- "device_id": "string",
- "device_ip": "string",
- "device_name": "string",
- "device_type": "string",
- "excluded_push_token": {
- "provider_type": "ANDROID",
- "token": "string"
}, - "hidden": true,
- "id": "string",
- "severity": "LOW",
- "text": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "url": "string",
- "user_id": "string"
}
The email address API for creating, updating and removing an email address for an user. The email address will be used for sending notifications to a user
userId required | string Get email channel configuration associated to the selected user |
Data of the channel configurion of the email channel
categories | Array of strings if one of these categories occures in a notification the user will not be notified by a notification himself |
codes | Array of strings Items Enum: "NOTIFY_INFO" "PROTECT_NOTIFY_BLOCKED_MALWARE" "PROTECT_NOTIFY_BLOCKED_FILTER_CATEGORY" "PROTECT_NOTIFY_BLOCKED_FILTER_BLACKLIST" "PROTECT_NOTIFY_NEW_DEVICE" "NOTIFY_LOGIN_SUCC" "NOTIFY_LOGIN_FAILED" "NOTIFY_LOGIN_SUSPICIOUS" if one of these codes occures in a notification the user will not be notified by notification himself |
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
userId required | string Id of the user to create the email address for |
Data of the new email
active | boolean Indicates if email address is active for notifications |
emailaddress required | string [ 0 .. 250 ] characters Email address of the user for notifications |
{- "active": true,
- "emailaddress": "string"
}
userId required | string Id or login of the user to which the email address to get is associated to |
emailaddressId required | string Id or value of the email address to get |
{- "active": true,
- "emailaddress": "string",
- "id": 0
}
userId required | string Id or login of the user to which the email address to update is associated to |
emailaddressId required | string Id or value of the email address to update |
create | boolean Create if not exists? |
Data of the email address
active | boolean Email address active for notifications |
emailaddress | string [ 0 .. 255 ] characters Email of the user for notifications |
{- "active": true,
- "emailaddress": "string"
}
{- "active": true,
- "emailaddress": "string",
- "id": 0
}
userId required | string Id or login of the user to which the email address to update is associated to |
emailaddressId required | string Id or value of the email address to update |
create | boolean Create if not exists? |
Data of the email address
active | boolean Indicates if email address is active for notifications |
emailaddress required | string [ 0 .. 250 ] characters Email address of the user for notifications |
{- "active": true,
- "emailaddress": "string"
}
{- "code": 0,
- "message": "string"
}
The phone number API for creating, updating and removing a phone number for an user. The phone number will be used for sending notifications to a user by sms
userId required | string Id of the user to create the phone number for |
Data of the new phone number
active | boolean Phone number active for notifications |
phone_number required | string [ 0 .. 250 ] characters Phone number of the user for sms notifications |
{- "active": true,
- "phone_number": "string"
}
userId required | string Id or login of the user to which the phonenumber to get is associdated to |
phonenumberId required | string Id or value of the phone number to get |
{- "active": true,
- "id": 0,
- "phone_number": "string"
}
userId required | string Id or login of the user to which the phonenumber to delete is associdated to |
phonenumberId required | string Id or value of the phone number to update |
create | boolean Create if not exists? |
Data of the phone number
active | boolean Phone number active for notifications |
phone_number | string [ 0 .. 255 ] characters Phone number of the user for sms notifications |
{- "active": true,
- "phone_number": "string"
}
{- "active": true,
- "id": 0,
- "phone_number": "string"
}
userId required | string Id or login of the user to which the phonenumber to delete is associdated to |
phonenumberId required | string Id or value of the phone number to update |
create | boolean Create if not exists? |
Data of the phone number
active | boolean Phone number active for notifications |
phone_number required | string [ 0 .. 250 ] characters Phone number of the user for sms notifications |
{- "active": true,
- "phone_number": "string"
}
{- "active": true,
- "id": 0,
- "phone_number": "string"
}
userId required | string Get sms channel configuration associated to the selected user |
Data of the channel configurion of the sms channel
categories | Array of strings if one of these categories occures in a notification the user will not be notified by a notification himself |
codes | Array of strings Items Enum: "NOTIFY_INFO" "PROTECT_NOTIFY_BLOCKED_MALWARE" "PROTECT_NOTIFY_BLOCKED_FILTER_CATEGORY" "PROTECT_NOTIFY_BLOCKED_FILTER_BLACKLIST" "PROTECT_NOTIFY_NEW_DEVICE" "NOTIFY_LOGIN_SUCC" "NOTIFY_LOGIN_FAILED" "NOTIFY_LOGIN_SUSPICIOUS" if one of these codes occures in a notification the user will not be notified by notification himself |
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
Email data
locale | string The selected language |
recipient required | string Recipient of the email. |
sender | string Sender of the email. |
token required | string The token which will be placed in the email to send. |
{- "locale": "string",
- "recipient": "string",
- "sender": "string",
- "token": "string"
}
userId required | string Id of the user to set the token for |
Data of the new token
active | boolean Token active for notifications |
id | integer <int32> Id of the push token. This value is optional. If a single push token is updated the id can be null or must be the same as in the path.When a push token will be created the id will not be respected. |
provider_type required | string Enum: "ANDROID" "IOS" IOS or ANDROID |
token required | string [ 0 .. 250 ] characters Token for push to the cloud |
{- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
userId required | string Get push channel configuration associated to the selected user |
Data of the channel configurion of the push channel
categories | Array of strings if one of these categories occures in a notification the user will not be notified by a notification himself |
codes | Array of strings Items Enum: "NOTIFY_INFO" "PROTECT_NOTIFY_BLOCKED_MALWARE" "PROTECT_NOTIFY_BLOCKED_FILTER_CATEGORY" "PROTECT_NOTIFY_BLOCKED_FILTER_BLACKLIST" "PROTECT_NOTIFY_NEW_DEVICE" "NOTIFY_LOGIN_SUCC" "NOTIFY_LOGIN_FAILED" "NOTIFY_LOGIN_SUSPICIOUS" if one of these codes occures in a notification the user will not be notified by notification himself |
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
{- "categories": [
- "string"
], - "codes": [
- "NOTIFY_INFO"
]
}
userId required | string Id or login of the user to which the pushtoken to delete is associdated to |
tokenId required | string Id or value of the pushtoken to get |
{- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
userId required | string Id or login of the user to which the pushtoken to delete is associdated to |
tokenId required | string Id or value of the pushtoken to update |
create | boolean Create if not exists? |
Data of the new pushtoken
active | boolean Use the token to notify |
provider_type required | string Enum: "ANDROID" "IOS" IOS or ANDROID |
token | string [ 0 .. 255 ] characters Token for push to the cloud |
{- "active": true,
- "provider_type": "ANDROID",
- "token": "string"
}
{- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
userId required | string Id or login of the user to which the pushtoken to update is associdated to |
tokenId required | string Id or value of the pushtoken to update |
create | boolean Create if not exists? |
Data of the new pushtoken
active | boolean Use the token to notify |
provider_type required | string Enum: "ANDROID" "IOS" IOS or ANDROID |
token | string [ 0 .. 255 ] characters Token for push to the cloud |
{- "active": true,
- "provider_type": "ANDROID",
- "token": "string"
}
{- "code": 0,
- "message": "string"
}
userId required | string Id or login of the user to replace the push tokens for |
List of push tokens
active | boolean Token active for notifications |
id | integer <int32> Id of the push token. This value is optional. If a single push token is updated the id can be null or must be the same as in the path.When a push token will be created the id will not be respected. |
provider_type required | string Enum: "ANDROID" "IOS" IOS or ANDROID |
token required | string [ 0 .. 250 ] characters Token for push to the cloud |
[- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
]
{- "elements": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "size": 0
}
userId required | string Id or login of the user to change the state of push tokens for |
Indicates if the push tokens should be enabled or disabled
enable required | boolean Enable or disable |
{- "enable": true
}
{- "elements": [
- {
- "active": true,
- "id": 0,
- "provider_type": "ANDROID",
- "token": "string"
}
], - "size": 0
}
The usermapping API to manage that a user can have different names in services which uses the notificationcenter
userId required | string Id of the user to set the usermapping for |
Data of the new usermapping
app required | string [ 1 .. 32 ] characters Name of the app |
user_name_in_app required | string [ 1 .. 50 ] characters The name of user in the app |
{- "app": "string",
- "user_name_in_app": "string"
}
userId required | string Id or login of the user to which the usermapping to delete is associdated to |
usermappingId required | integer <int32> Id of usermapping to get |
{- "app": "string",
- "id": 0,
- "user_name_in_app": "string"
}
userId required | string Id or login of the user to which the usermapping to delete is associdated to |
usermappingId required | integer <int32> Id of usermapping to update |
create | boolean Create if not exists? |
Data of the new usermapping
app required | string [ 1 .. 32 ] characters Name of the app |
user_name_in_app required | string [ 1 .. 50 ] characters The name of user in the app |
{- "app": "string",
- "user_name_in_app": "string"
}
{- "code": 0,
- "message": "string"
}
userId required | string Id of the user to create the device for |
Data of the device
active_for_notifications | boolean Indicates if notifications about this device should be send. |
device_mac required | string [ 1 .. 50 ] characters The deviceId (MAC) of the device. The deviceId is unique for all devices. |
device_name | string Name of the device |
device_type | string Type of the device |
{- "active_for_notifications": true,
- "device_mac": "string",
- "device_name": "string",
- "device_type": "string"
}
userId required | string Id of the user to get the devices for |
deviceId required | string Id(Integer) or deviceId(MAC) of the device to get |
{- "active_for_notifications": true,
- "device_mac": "string",
- "device_name": "string",
- "device_type": "string",
- "id": 0
}
userId required | string Id of the user to create the device for |
deviceId required | string Id of the device to update |
Data of the device
active_for_notifications | boolean Indicates if notifications about this device should be send. |
device_mac required | string [ 0 .. 32 ] characters The deviceId (MAC) of the device. The deviceId is unique for all devices. |
device_name | string Name of the device |
device_type | string Type of the device |
{- "active_for_notifications": true,
- "device_mac": "string",
- "device_name": "string",
- "device_type": "string"
}
userId required | string Id of the user to create the device for |
deviceId required | string Id of the device to update |
create | boolean Create if not exists? |
Data of the device
active_for_notifications | boolean Indicates if notifications about this device should be send. |
device_mac required | string [ 1 .. 50 ] characters The deviceId (MAC) of the device. The deviceId is unique for all devices. |
device_name | string Name of the device |
device_type | string Type of the device |
{- "active_for_notifications": true,
- "device_mac": "string",
- "device_name": "string",
- "device_type": "string"
}
userId required | string Id of the user to get the devices for |
{- "elements": [
- {
- "active_for_notifications": true,
- "device_mac": "string",
- "device_name": "string",
- "device_type": "string",
- "id": 0
}
], - "size": 0
}
userId required | string Id of the user to create the device for |
Data of the device
active_for_notifications | boolean Indicates if notifications about this device should be send. |
device_mac required | string [ 1 .. 50 ] characters The deviceId (MAC) of the device. The deviceId is unique for all devices. |
device_name | string Name of the device |
device_type | string Type of the device |
[- {
- "active_for_notifications": true,
- "device_mac": "string",
- "device_name": "string",
- "device_type": "string"
}
]
The token will only be generated. It will not be added automatically
The body
roles | Array of strings List of roles which the generated JWT-Token will contain. |
{- "roles": [
- "string"
]
}