E-Mail API specification (567cca4d1c6bfa19b8960f416b4ea05344c037c1)
Download OpenAPI specification:
The email-service is used to configure and manage users' email-addresses.
List
Returns all configured alarm-notification email addresses of an user
Authorizations:
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
[- {
- "active": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}
]Create
Creates an email configuration
Authorizations:
query Parameters
| organization_id | integer requesting organization, not required if user accesses his own resources |
Request Body schema: application/jsonrequired
email configuration payload
| active | boolean defines, if this email is active for alarm notifications |
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
{- "active": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Response samples
- 200
{- "active": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Get
Creates an email configuration
Authorizations:
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
{- "active": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Update
Updates an email configuration
Authorizations:
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/jsonrequired
email configuration payload
| active | boolean defines, if this email is active for alarm notifications |
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
{- "active": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Response samples
- 200
{- "active": true,
- "email": "string",
- "id": 0,
- "name": "string",
- "ownerID": 0
}Delete
Deletes an email configuration
Authorizations:
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
{- "status": "deleted"
}GetDisabledOrganization
Returns whether the given organization has disabled this way of alarming or not
Authorizations:
query Parameters
| organization_id required | integer requesting organization |
Responses
Response samples
- 200
[- {
- "isDisabled": true
}
]SetDisabledOrganization
Sets whether the given organization has this way of alarming disabled or not
Authorizations:
query Parameters
| organization_id required | integer requesting organization |
Request Body schema: application/jsonrequired
isDisabled payload
| isDisabled | boolean |
Responses
Request samples
- Payload
{- "isDisabled": true
}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:
query Parameters
| user_id required | integer id of the user |
| organization_id required | integer id of the organization |
Responses
Response samples
- 200
{- "activeCount": 0,
- "anyActive": true,
- "organizationPermission": true,
- "userPermission": true
}UpsertSettings
Creates or updates the email settings for the passed organization
Authorizations:
path Parameters
| organizationID required | integer |
Request Body schema: application/jsonrequired
| backgroundColor | string |
| footerText | string |
Responses
Request samples
- Payload
{- "backgroundColor": "string",
- "footerText": "string"
}GetPermission
Returns true if there is an active permission for the passed organization or specifically for the passed user in an organization.
Authorizations:
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:
Request Body schema: application/jsonrequired
restriction configuration with user and organization id
| organizationID | integer <int64> |
| userID | integer <int64> |
Responses
Request samples
- Payload
{- "organizationID": 0,
- "userID": 0
}