E-Mail API specification (1dcd2760e5fc02e4085fba7ad089fcba2d76d057)

Download OpenAPI specification:Download

The email-service is used to configure and manage users' email-addresses.

email

List

Returns all configured alarm-notification email addresses of an user

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
owner_id
required
integer

ID of an user

organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Creates an email configuration

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Request Body schema: application/json
required

email configuration payload

active
boolean

defines, if this email is active for alarm notifications

email
string

email address

id
integer <int64>

id of this email

name
string

user defined name for this address (e.g. private)

ownerID
integer <int64>

assinged user id for this email

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Get

Creates an email configuration

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
emailID
required
integer

ID of an email configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Update

Updates an email configuration

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
emailID
required
integer

ID of an email configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Request Body schema: application/json
required

email configuration payload

active
boolean

defines, if this email is active for alarm notifications

email
string

email address

id
integer <int64>

id of this email

name
string

user defined name for this address (e.g. private)

ownerID
integer <int64>

assinged user id for this email

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Response samples

Content type
application/json
{
  • "active": true,
  • "email": "string",
  • "id": 0,
  • "name": "string",
  • "ownerID": 0
}

Delete

Deletes an email configuration

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
emailID
required
integer

ID of an email configuration

query Parameters
organization_id
integer

requesting organization, not required if user accesses his own resources

Responses

Response samples

Content type
application/json
{
  • "status": "deleted"
}

organizations

GetDisabledOrganization

Returns whether the given organization has disabled this way of alarming or not

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

requesting organization

Responses

Response samples

Content type
application/json
[
  • {
    }
]

SetDisabledOrganization

Sets whether the given organization has this way of alarming disabled or not

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

requesting organization

Request Body schema: application/json
required

isDisabled payload

isDisabled
boolean

Responses

Request samples

Content type
application/json
{
  • "isDisabled": true
}

emails

AnyActive

Check if any email is active for the passed owner id in the passed organization id and get the permissions of the user and the organization

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
user_id
required
integer

id of the user

organization_id
required
integer

id of the organization

Responses

Response samples

Content type
application/json
{
  • "activeCount": 0,
  • "anyActive": true,
  • "organizationPermission": true,
  • "userPermission": true
}

email-settings

GetSettings

Gets the configured organization email settings

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

Responses

Response samples

Content type
application/json
{
  • "backgroundColor": "string",
  • "footerText": "string"
}

UpsertSettings

Creates or updates the email settings for the passed organization

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer
Request Body schema: application/json
required
backgroundColor
string
footerText
string

Responses

Request samples

Content type
application/json
{
  • "backgroundColor": "string",
  • "footerText": "string"
}

user-permissions

GetPermission

Returns true if there is an active permission for the passed organization or specifically for the passed user in an organization.

Authorizations:
API_TokenPersonal-Access-Token
query Parameters
organization_id
required
integer

ID of an organization

user_id
integer

optional ID of a user in this organization

Responses

Allows a specific user in a specific organization to use this service's alarming-type.

Authorizations:
API_TokenPersonal-Access-Token
Request Body schema: application/json
required

restriction configuration with user and organization id

organizationID
integer <int64>
userID
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "organizationID": 0,
  • "userID": 0
}

Removes a specific user's permission to use this service's alarming-type in an organization.

Authorizations:
API_TokenPersonal-Access-Token
path Parameters
organizationID
required
integer

ID of an organization

userID
required
integer

ID of a user in this organization

Responses