List the existing trigger(s)
List the existing trigger(s) with the capability to filter on type and/or module.
|
types
array of string
Restrict the list to these trigger types. When omitted, triggers of every type are listed. Repeat the parameter to pass several types. |
-
200 Trigger list
application/jsonArray [
typestring requiredThe type of notification
Valueemailtemplateobject (Email template) requiredWhere and what to send in the email
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
toarray of stringThe recipient(s) of the e-mail
bodystringThe body of the e-mail. This is a customizable template string.
idstring (Internal ID) requiredObject internal ID
namestring requiredName of the notification
eventstring requiredEvent 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_x509_ca_expirationon_ocsp_signer_expirationon_tsa_signer_expirationon_credentials_expirationon_license_expirationon_trigger_errorrunPeriodstringTime period at which the notification needs to run. Can only be defined on expiration and pending events.
triggersobject (TriggersNotificationBase)onTriggerErrorarray of stringNotifications 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
EnumGETPATCHPUTPOSTHEADDELETEurlstring 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. Defaults to 5 seconds when omitted.
idstring (Internal ID) requiredObject internal ID
namestring requiredName of the notification
eventstring requiredEvent 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_x509_ca_expirationon_ocsp_signer_expirationon_tsa_signer_expirationon_credentials_expirationon_license_expirationon_trigger_errorcredentialsstringName of the credentials to use for authentication
headersarray of object (header)The headers of the request
Array [
namestringThe header name
valuestringThe header value. This is a customizable template string.
]
payloadTypestringFor UI purposes in order to format the body correctly
EnumjsontextpayloadstringThe body of the request. This is a customizable template string.
proxystringName of a Proxy to use while making the request
runPeriodstringTime period at which the notification needs to run. Can only be defined on expiration and pending events.
triggersobject (TriggersNotificationBase)onTriggerErrorarray of stringNotifications 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 requiredrlAttributestring requiredName of the LDAP attribute in which the revocation list is stored
followReferralsboolean requiredidstring (Internal ID) requiredObject internal ID
namestring requiredName of the external CRL storage
typestring requiredThe type of trigger
Valueexternal_rl_storageproxystringName of the HTTP proxy to use. Can only be set when secure is enabled
timeoutstringTimeout of the LDAP connection. Defaults to 1 minute when omitted
credentialsstringName of the password credentials used to bind to the LDAP server. Registration accepts a storage without credentials, but publishing then fails
descriptionstringThe description of this external CRL storage
triggersobject (TriggersBase)onTriggerErrorarray of stringNotifications to run when this trigger fails
storageTypestring requiredThe type of external CRL storage
Values3forcePathStyleboolean requiredbucketstring requiredidstring (Internal ID) requiredObject internal ID
namestring requiredName of the external CRL storage
typestring requiredThe type of trigger
Valueexternal_rl_storageroleArnstringregionstringproxystringtimeoutstringTimeout of the S3 requests. Defaults to 5 seconds when omitted
rlAliasstringTemplate string defining the object name in the S3 bucket
endpointstringchecksumModestringWhen the S3 client computes request checksums
Enumwhen_supportedwhen_requireddescriptionstringThe description of this external CRL storage
credentialsstringName of the credentials to use to authenticate on the storage
triggersobject (TriggersBase)onTriggerErrorarray of stringNotifications 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.
idstring (Internal ID) requiredObject internal ID
namestring requiredName of the external CRL storage
typestring requiredThe type of trigger
Valueexternal_rl_storagefingerprintstringSSH fingerprint of the host to ensure connection to the correct host. If not defined, all fingerprints are accepted.
timeoutstringcredentialsstringName of the password or SSH key credentials used to log in on the host. Registration accepts a storage without credentials, but publishing then fails
descriptionstringThe description of this external CRL storage
triggersobject (TriggersBase)onTriggerErrorarray of stringNotifications 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.
idstring (Internal ID) requiredObject internal ID
namestring requiredName of the external CRL storage
typestring requiredThe type of trigger
Valueexternal_rl_storagefingerprintstringSSH fingerprint of the host to ensure connection to the correct host. If not defined, all fingerprints are accepted.
timeoutstringcredentialsstringName of the password or SSH key credentials used to log in on the host. Registration accepts a storage without credentials, but publishing then fails
descriptionstringThe description of this external CRL storage
triggersobject (TriggersBase)onTriggerErrorarray of stringNotifications to run when this trigger fails
storageTypestring requiredThe type of external CRL storage
Valuestreamendpointstring requiredStream base endpoint
credentialsstring requiredName of the password or X.509 credentials used to authenticate on the distant Stream instance
idstring (Internal ID) requiredObject internal ID
namestring requiredName of the external CRL storage
typestring requiredThe type of trigger
Valueexternal_rl_storagecastringName 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.
timeoutstringTimeout when making the request to stream. Defaults to 5 seconds when omitted
proxystringName of the HTTP proxy to use to reach the distant Stream instance
descriptionstringThe description of this external CRL storage
triggersobject (TriggersBase)onTriggerErrorarray of stringNotifications to run when this trigger fails
]
-
204 No trigger defined, or none the principal is allowed to audit on an entitled module
-
400 Bad Request
application/problem+jsonerrorstring 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 ProviderdetailstringA 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-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 existdetailstringA 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 expireddetailstringA 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 expireddetailstringA 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 errordetailstringA 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
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 LicensedetailstringA 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 LicensedetailstringA 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 ErrordetailstringA 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 errordetailstringA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807