Register a new trigger
Register a new trigger
The trigger to register
|
type
string
requiredThe type of notification
Value
email
|
|||||||||||
|
emailTemplate
object (Email template)
required
Where and what to send in the email |
|||||||||||
|
|||||||||||
|
name
string
requiredName of the notification |
|||||||||||
|
events
array of string
requiredEvent on which the notification runs. This MUST contain only one value. |
|||||||||||
|
ifPkcs12
boolean | null
On events triggering an enrollment, select if mail is sent:
|
|||||||||||
|
attachPemCertificate
boolean | null
Attach the certificate in PEM format if available |
|||||||||||
|
attachPemBundle
boolean | null
Attach the certificate and its trust chain (bundle) in PEM format if available |
|||||||||||
|
attachDerCertificate
boolean | null
Attach the certificate in DER format if available |
|||||||||||
|
attachPkcs7
boolean | null
Attach the certificate in PKCS7 format if available |
|||||||||||
|
attachPkcs7Bundle
boolean | null
Attach the certificate and its trust chain (bundle) in PKCS7 format if available |
|||||||||||
|
attachPkcs12
boolean | null
Attach the certificate in PKCS#12 format if available |
|||||||||||
|
retries
integer | null
Number of retries when the notification fails |
|||||||||||
|
runPeriod
string | null
Time period at which the notification needs to run. Can only be defined on expiration and pending events. |
|||||||||||
|
licenseUsagePercent
integer | null
License usage at which the notification needs to run (between 0 and 100). Must be defined on on_license_usage event and must NOT be defined otherwise. |
|||||||||||
|
runOnRenewed
boolean | null
Must be defined on on_expire event and must NOT be defined otherwise. If true, the notification runs even if the certificate was renewed. |
|||||||||||
|
type
string
requiredThe type of notification
Value
webhook
|
||||||||||||
|
webhookTemplate
object (Webhook template)
required
Where and what to send in the webhook |
||||||||||||
|
||||||||||||
|
name
string
requiredName of the notification |
||||||||||||
|
events
array of string
requiredEvent on which the notification runs. This MUST contain only one value. |
||||||||||||
|
retries
integer | null
Number of retries when the notification fails (non 200 return code) |
||||||||||||
|
proxy
string | null
Name of a Proxy to use while sending the webhook |
||||||||||||
|
timeout
string
Timeout for the webhook request |
||||||||||||
|
runPeriod
string | null
Time period at which the notification needs to run. Can only be defined on expiration and pending events. |
||||||||||||
|
licenseUsagePercent
integer | null
License usage at which the notification needs to run (between 0 and 100). Must be defined on on_license_usage event and must NOT be defined otherwise. |
||||||||||||
|
runOnRenewed
boolean | null
Must be defined on on_expire event and must NOT be defined otherwise. If true, the notification runs even if the certificate was renewed. |
||||||||||||
|
type
string
requiredThe type of notification
Value
rest
|
|||
|
method
string
requiredThe HTTP method to use for the request |
|||
|
url
string
requiredThe URL to request |
|||
|
authenticationType
string
requiredThe authentication type to use while making the REST call. Is linked to credentials.
Enum
noauth
basic
x509
bearer
custom
|
|||
|
expectedHttpCodes
array of integer
requiredThe success HTTP codes for the request. If the return code is not in this list, the notification will be considered failed. |
|||
|
timeout
string
requiredTimeout for the HTTP request. |
|||
|
name
string
requiredName of the notification |
|||
|
events
array of string
requiredEvent on which the notification runs. This MUST contain only one value. |
|||
|
retries
integer | null
Number of retries when the notification fails (depends on expectedHttpCodes) |
|||
|
credentials
string | null
Name of the credentials to use for authentication |
|||
|
headers
array of object | null (Header)
The headers of the request |
|||
|
Array [
] |
|||
|
payloadType
string | null
For UI purposes in order to format the body correctly |
|||
|
payload
string | null
The body of the request. Can contain dynamic attributes. |
|||
|
proxy
string | null
Name of a Proxy to use while making the request |
|||
|
runPeriod
string | null
Time period at which the notification needs to run. Can only be defined on expiration and pending events. |
|||
|
licenseUsagePercent
integer | null
License usage at which the notification needs to run (between 0 and 100). Must be defined on on_license_usage event and must NOT be defined otherwise. |
|||
|
runOnRenewed
boolean | null
Must be defined on on_expire event and must NOT be defined otherwise. If true, the notification runs even if the certificate was renewed. |
|||
|
name
string
required |
|
type
string
required
Value
akv
|
|
connector
string
required |
|
retries
integer | null
|
|
name
string
required |
|
type
string
required
Value
f5client
|
|
connector
string
required |
|
retries
integer | null
|
|
name
string
required |
|
type
string
required
Value
f5as3
|
|
connector
string
required |
|
retries
integer | null
|
|
name
string
required |
|
type
string
required
Value
aws
|
|
connector
string
required |
|
retries
integer | null
|
|
name
string
required |
|
type
string
required
Value
intunepkcs
|
|
connector
string
required |
|
retries
integer | null
|
|
name
string
required |
|
type
string
required
Value
gcm
|
|
connector
string
required |
|
retries
integer | null
|
|
name
string
required |
|
type
string
required
Value
ldappub
|
|
connector
string
required |
|
retries
integer | null
|
-
201 Trigger successfully registered
application/jsontypestring requiredThe type of notification
ValueemailemailTemplateobject (Email template) requiredWhere and what to send in the email
toarray of objects (Email recipient) requiredThe recipient(s) of the e-mail
Array [
typestring requiredThe type of email recipient. Apart from the static recipient, all are deduced from the request's context.
Enumstaticteam_contactlabelrequestercontactapprovercertificate_rfc822nameteam_managercertificate_ownerlifecycle_operatorsemailstring | nullMandatory for static recipient and ignored otherwise. The address to send the email to.
labelstring | nullMandatory for label recipient and ignored otherwise. The label name to fetch the address from.
]
fromstring requiredThe sender name of the e-mail
titlestring requiredThe title of the e-mail
isHtmlboolean requiredWhether the e-mail contains HTML code
bodystring | nullThe body of the e-mail
namestring requiredName of the notification
eventsarray of string requiredEvent on which the notification runs. This MUST contain only one value.
ifPkcs12boolean | nullOn events triggering an enrollment, select if mail is sent:
- Always: set the value to null
- Only when a PKCS#12 is available in the request: set the value to true
- Only when a PKCS#12 is not in the request: set the value to false
attachPemCertificateboolean | nullAttach the certificate in PEM format if available
attachPemBundleboolean | nullAttach the certificate and its trust chain (bundle) in PEM format if available
attachDerCertificateboolean | nullAttach the certificate in DER format if available
attachPkcs7boolean | nullAttach the certificate in PKCS7 format if available
attachPkcs7Bundleboolean | nullAttach the certificate and its trust chain (bundle) in PKCS7 format if available
attachPkcs12boolean | nullAttach the certificate in PKCS#12 format if available
retriesinteger | nullNumber of retries when the notification fails
runPeriodstring | nullTime period at which the notification needs to run. Can only be defined on expiration and pending events.
licenseUsagePercentinteger | nullLicense usage at which the notification needs to run (between 0 and 100). Must be defined on on_license_usage event and must NOT be defined otherwise.
runOnRenewedboolean | nullMust be defined on on_expire event and must NOT be defined otherwise. If true, the notification runs even if the certificate was renewed.
typestring requiredThe type of notification
ValuewebhookwebhookTemplateobject (Webhook template) requiredWhere and what to send in the webhook
toobject (Webhook Recipient) requiredThe target of the webhook
typestring requiredDefine if the webhook url and type is defined here or will be dynamically taken from the certificate's team
Enumstaticteamwebhookobject (Webhook Definition)The definition of the webhook. Mandatory in static mode.
typestring requiredThe type of the webhook (Teams or Slack/Mattermost)
Enumslackteamsurlstring requiredThe URL of the webhook
titlestring requiredThe title of the webhook notification (special formatting)
bodystring | nullThe body of the notification. Can contain dynamic attributes.
namestring requiredName of the notification
eventsarray of string requiredEvent on which the notification runs. This MUST contain only one value.
retriesinteger | nullNumber of retries when the notification fails (non 200 return code)
proxystring | nullName of a Proxy to use while sending the webhook
timeoutstringTimeout for the webhook request
runPeriodstring | nullTime period at which the notification needs to run. Can only be defined on expiration and pending events.
licenseUsagePercentinteger | nullLicense usage at which the notification needs to run (between 0 and 100). Must be defined on on_license_usage event and must NOT be defined otherwise.
runOnRenewedboolean | nullMust be defined on on_expire event and must NOT be defined otherwise. If true, the notification runs even if the certificate was renewed.
typestring requiredThe type of notification
Valuerestmethodstring requiredThe HTTP method to use for the request
urlstring requiredThe URL to request
authenticationTypestring requiredThe authentication type to use while making the REST call. Is linked to credentials.
Enumnoauthbasicx509bearercustomexpectedHttpCodesarray of integer requiredThe success HTTP codes for the request. If the return code is not in this list, the notification will be considered failed.
timeoutstring requiredTimeout for the HTTP request.
namestring requiredName of the notification
eventsarray of string requiredEvent on which the notification runs. This MUST contain only one value.
retriesinteger | nullNumber of retries when the notification fails (depends on expectedHttpCodes)
credentialsstring | nullName of the credentials to use for authentication
headersarray of object | null (Header)The headers of the request
Array [
namestring requiredThe header name
valuestring requiredThe header value
]
payloadTypestring | nullFor UI purposes in order to format the body correctly
payloadstring | nullThe body of the request. Can contain dynamic attributes.
proxystring | nullName of a Proxy to use while making the request
runPeriodstring | nullTime period at which the notification needs to run. Can only be defined on expiration and pending events.
licenseUsagePercentinteger | nullLicense usage at which the notification needs to run (between 0 and 100). Must be defined on on_license_usage event and must NOT be defined otherwise.
runOnRenewedboolean | nullMust be defined on on_expire event and must NOT be defined otherwise. If true, the notification runs even if the certificate was renewed.
_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueakvconnectorstring requiredretriesinteger | null_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuef5clientconnectorstring requiredretriesinteger | null_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuef5as3connectorstring requiredretriesinteger | null_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueawsconnectorstring requiredretriesinteger | null_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueintunepkcsconnectorstring requiredretriesinteger | null_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValuegcmconnectorstring requiredretriesinteger | null_idstring (Internal ID) requiredObject internal ID
namestring requiredtypestring requiredValueldappubconnectorstring requiredretriesinteger | null -
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueTRIG-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Triggertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Triggerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueTRIG-004messagestring requiredA short, human-readable summary of the problem type
ValueTrigger already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueTrigger already existsdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticatedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticateddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect pathtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect pathdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueTRIG-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807