Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

admin-controller

Send test email (sendTestMail)

Attempts to send test email to the System Administrator User using Mail Settings provided as a parameter. You may change the 'To' email in the user profile of the System Administrator.

Available for users with 'SYS_ADMIN' authority.

post/api/admin/settings/testMail

Request body

createdTimeinteger

Timestamp of the settings creation, in milliseconds

keystring

The Administration Settings key, (e.g. 'general' or 'mail')

{"stackTrail":"components:schemas:JsonNode","oasType":"schema","type":"unknown","description":"A value representing the any type (object or primitive)","example":{}}

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "ADMIN_SETTINGS"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "key": "mail",
  "jsonValue": {}
}

Response

OK