notificationcenter (1.0)

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.

Authentication

X-API-Key

Security Scheme Type API Key
Header parameter name: X-API-Key

user

The user API to manage the users of the notifcationcenter

Create a user

Authorizations:
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "emailaddress": [
    ],
  • "locale": "string",
  • "phonenumbers": [
    ],
  • "pushtokens": [
    ],
  • "userMappings": [
    ],
  • "user_id": "string"
}

Delete a user

Authorizations:
path Parameters
userId
required
string

The id of the user to delete

Responses

Get a user with the userId

Authorizations:
path Parameters
userId
required
string

The user id of the user to get

Responses

Response samples

Content type
application/json
{
  • "emailaddress": [
    ],
  • "id": 0,
  • "locale": "string",
  • "phonenumbers": [
    ],
  • "pushtokens": [
    ],
  • "userMappings": [
    ],
  • "user_id": "string"
}

Partial update of a user

Authorizations:
path Parameters
userId
required
string

The current id of the user to update

Request Body schema: application/json

Update data for a user

locale
string

The selected language of the user

user_id
string

Unique user id for notification centre

Responses

Request samples

Content type
application/json
{
  • "locale": "string",
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "emailaddress": [
    ],
  • "id": 0,
  • "locale": "string",
  • "phonenumbers": [
    ],
  • "pushtokens": [
    ],
  • "userMappings": [
    ],
  • "user_id": "string"
}

Update or create a user

Authorizations:
path Parameters
userId
required
string

The current id of the user to update

query Parameters
create
boolean

Create if not exists?

add
boolean

Add and not replace notification channels?

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "emailaddress": [
    ],
  • "locale": "string",
  • "phonenumbers": [
    ],
  • "pushtokens": [
    ],
  • "userMappings": [
    ],
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Get the current channel configuration of all channels of the user with the userId. If there is no channel configuration the lists of the configuration will be empty

Authorizations:
path Parameters
userId
required
string

Id of the user to create the device for

Responses

Response samples

Content type
application/json
{
  • "email": {
    },
  • "push": {
    },
  • "sms": {
    }
}

Sets or updates the channel configuration of all channels of the user with the userId. The old channel configurations will be overwritten completly

Authorizations:
path Parameters
userId
required
string

Id of the user to create the notificationconfiguration for

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "email": {
    },
  • "push": {
    },
  • "sms": {
    }
}

Response samples

Content type
application/json
{
  • "email": {
    },
  • "push": {
    },
  • "sms": {
    }
}

users

The users API to get the users list and count of the notifcationcenter

Get a complete list of all registered users

Authorizations:
query Parameters
page
integer <int32>

page index of paging

size
integer <int32>

size of a page in paging

Responses

Response samples

Content type
application/json
{
  • "elements": [
    ],
  • "pageCurrent": 0,
  • "pageSize": 0,
  • "pagesTotal": 0,
  • "size": 0
}

Add a list of new users to the notificationcenter. If there is already a user of the list registered at the notificationcenter none of the users will be added and an error will be returned.

Authorizations:
Request Body schema: application/json

List of new users

Array
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

Responses