List the existing trigger(s)
List the existing trigger(s) with the capability to filter on type and/or module.
|
types
array of string
required |
|
module
string | null
Enum
acme
est
aws
f5client
intune
jamf
scep
wcce
webra
intunepkcs
|
-
200 Trigger list
application/jsonArray [
typestring requiredThe type of notification
Valueemailtemplateobject (Email template) requiredWhere and what to send in the email
toarray of string requiredThe recipient(s) of the e-mail
fromstring requiredThe sender name of the e-mail
titlestring requiredThe title of the e-mail. This is a customizable template string.
isHtmlboolean requiredWhether the e-mail contains HTML code
bodystring | nullThe body of the e-mail. This is a customizable template string.
namestringName of the notification
runPeriodstring | nullTime period at which the notification needs to run. Can only be defined on expiration and pending events.
eventstringEvent on which the notification runs
Enumon_crl_genon_crl_gen_erroron_crl_gen_recoveron_crl_updateon_crl_update_erroron_crl_update_recoveron_crl_syncon_crl_sync_erroron_crl_expirationon_krl_genon_krl_gen_erroron_krl_gen_recoveron_krl_syncon_krl_sync_erroron_krl_expirationon_x509_ca_expirationon_ocsp_signer_expirationon_tsa_signer_expirationon_credentials_expirationon_license_expirationon_trigger_errortriggersobject | null (TriggersNotificationBase)onTriggerErrorarray of string | nullNotifications to run when this notification fails. Not available if the event for the notification is already on_trigger_error
typestring requiredThe type of notification
Valuerestmethodstring requiredThe HTTP method to use for the request
urlstring requiredThe URL to request. This is a template string and can be customized.
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.
credentialsstring | nullName of the credentials to use for authentication
headersarray of object | null (header)The headers of the request
Array [
namestringThe header name
valuestringThe header value. This is a customizable template string.
]
payloadTypestring | nullFor UI purposes in order to format the body correctly
payloadstring | nullThe body of the request. This is a customizable template string.
proxystring | nullName of a Proxy to use while making the request
namestringName of the notification
runPeriodstring | nullTime period at which the notification needs to run. Can only be defined on expiration and pending events.
eventstringEvent on which the notification runs
Enumon_crl_genon_crl_gen_erroron_crl_gen_recoveron_crl_updateon_crl_update_erroron_crl_update_recoveron_crl_syncon_crl_sync_erroron_crl_expirationon_krl_genon_krl_gen_erroron_krl_gen_recoveron_krl_syncon_krl_sync_erroron_krl_expirationon_x509_ca_expirationon_ocsp_signer_expirationon_tsa_signer_expirationon_credentials_expirationon_license_expirationon_trigger_errortriggersobject | null (TriggersNotificationBase)onTriggerErrorarray of string | nullNotifications to run when this notification fails. Not available if the event for the notification is already on_trigger_error
storageTypestring requiredThe type of external CRL storage
Valueldaphoststring requiredportinteger requiredsecureboolean requireddisableHostnameValidationboolean requiredbaseDNstring requiredfilterstring requiredcrlAttributestring requiredfollowReferralsboolean requiredproxystring | nulltimeoutstring | nullnamestringName of the external CRL storage
typestringThe type of trigger
Valueexternal_rl_storagedescriptionstringThe description of this external CRL storage
credentialsstringName of the credentials to use to authenticate on the storage
triggersobject | null (TriggersBase)onTriggerErrorarray of string | nullNotifications to run when this trigger fails
storageTypestring requiredThe type of external CRL storage
Values3forcePathStyleboolean requiredbucketstring requiredroleArnstring | nullregionstring | nullproxystring | nulltimeoutstring | nullrlAliasstring | nullTemplate string defining the object name in the S3 bucket
endpointstring | nullnamestringName of the external CRL storage
typestringThe type of trigger
Valueexternal_rl_storagedescriptionstringThe description of this external CRL storage
credentialsstringName of the credentials to use to authenticate on the storage
triggersobject | null (TriggersBase)onTriggerErrorarray of string | nullNotifications to run when this trigger fails
storageTypestring requiredThe type of external CRL storage
Valuescphoststring requiredHost to push the file to
portinteger requiredPort on which to access the host
useCompressionboolean requiredEnable compression for the protocol.
pathstring requiredTemplate string to define the path on the host machine.
credentialsstring requiredName of the credentials to use to authenticate on the storage
fingerprintstring | nullSSH fingerprint of the host to ensure connection to the correct host. If not defined, all fingerprints are accepted.
timeoutstring | nullnamestringName of the external CRL storage
typestringThe type of trigger
Valueexternal_rl_storagedescriptionstringThe description of this external CRL storage
triggersobject | null (TriggersBase)onTriggerErrorarray of string | nullNotifications to run when this trigger fails
storageTypestring requiredThe type of external CRL storage
Valuesftphoststring requiredHost to push the file to
portinteger requiredPort on which to access the host
useCompressionboolean requiredEnable compression for the protocol.
pathstring requiredTemplate string to define the path on the host machine.
credentialsstring requiredName of the credentials to use to authenticate on the storage
fingerprintstring | nullSSH fingerprint of the host to ensure connection to the correct host. If not defined, all fingerprints are accepted.
timeoutstring | nullnamestringName of the external CRL storage
typestringThe type of trigger
Valueexternal_rl_storagedescriptionstringThe description of this external CRL storage
triggersobject | null (TriggersBase)onTriggerErrorarray of string | nullNotifications to run when this trigger fails
storageTypestring requiredThe type of external CRL storage
Valuestreamendpointstring requiredStream base endpoint
credentialsstring requiredName of the credentials to use to authenticate on the storage
castring | nullName of the ca on the distant Stream instance. This is a customizable template string. If not defined, the ca name on this Stream instance is given.
timeoutstring | nullTimeout when making the request to stream
namestringName of the external CRL storage
typestringThe type of trigger
Valueexternal_rl_storagedescriptionstringThe description of this external CRL storage
triggersobject | null (TriggersBase)onTriggerErrorarray of string | nullNotifications to run when this trigger fails
]
-
204 No trigger defined or insufficient permissions
-
401 Unauthorized request
application/problem+jsonerrorstring 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 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
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
ValueAuthentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueAuthentication 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
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
ValueTRIGGER-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
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