E-Mail API specification (887cf3d4f37487346e33ee5d2c4aee5e8f74aa6e)

Download OpenAPI specification:Download

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

Authentication

API_Token

You can generate an API-Token in the permissions-settings of your organization. All requests will be performed in the scope of this organization. Requests regarding users will fail.

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

Personal-Access-Token

You can generate a Personal Access Token in your profile settings. All requests will be performed as the user who created the token, with permissions as configured in each organization.

Security Scheme Type	API Key
Header parameter name:	Personal-Access-Token

email

List

Returns all configured alarm-notification email addresses of an user

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

200

Content type

application/json

[{"active": true,
"email": "string",
"id": 0,
"name": "string",
"ownerID": 0
}
]

Create

Creates an email configuration

query Parameters

organization_id

integer

requesting organization, not required if user accesses his own resources

Request Body schema: application/json

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

Payload

Content type

application/json

{"active": true,
"email": "string",
"id": 0,
"name": "string",
"ownerID": 0
}

Response samples

200

Content type

application/json

{"active": true,
"email": "string",
"id": 0,
"name": "string",
"ownerID": 0
}

Get

Creates an email configuration

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

200

Content type

application/json

{"active": true,
"email": "string",
"id": 0,
"name": "string",
"ownerID": 0
}

Update

Updates an email configuration

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

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

Payload

Content type

application/json

{"active": true,
"email": "string",
"id": 0,
"name": "string",
"ownerID": 0
}

Response samples

200

Content type

application/json

{"active": true,
"email": "string",
"id": 0,
"name": "string",
"ownerID": 0
}

Delete

Deletes an email configuration

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

200

Content type

application/json

{"status": "deleted"
}

organizations

GetDisabledOrganization

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

query Parameters

organization_id

required

integer

requesting organization

Responses

Response samples

200

Content type

application/json

[{"isDisabled": true
}
]

SetDisabledOrganization

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

query Parameters

organization_id

required

integer

requesting organization

Request Body schema: application/json

isDisabled payload

isDisabled

boolean

Responses

Request samples

Payload

Content type

application/json

{"isDisabled": true
}

emails

AnyActive

Check if any email is active for the passed owner id in the passed organization id

query Parameters

user_id required	integer id of the user
organization_id required	integer id of the organization

Responses

Response samples

200

Content type

application/json

{"activeCount": 0,
"anyActive": true
}

email-settings

GetSettings

Gets the configured organization email settings

path Parameters

organizationID

required

integer

Responses

Response samples

200

Content type

application/json

{"backgroundColor": "string",
"footerText": "string"
}

UpsertSettings

Creates or updates the email settings for the passed organization

path Parameters

organizationID

required

integer

Request Body schema: application/json

backgroundColor	string
footerText	string

Responses

Request samples

Payload

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.

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.

Request Body schema: application/json

restriction configuration with user and organization id

organizationID	integer <int64>
userID	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"organizationID": 0,
"userID": 0
}

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

path Parameters

organizationID required	integer ID of an organization
userID required	integer ID of a user in this organization