Export configuration items
Export configuration items
Items to export
|
cas
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
pkiQueues
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
pkiConnectors
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
roles
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
teams
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
passwordPolicies
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
scimProfiles
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
notifications
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
datasources
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
discoveryCampaigns
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
thirdParties
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
reports
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
triggers
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
automations
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
executions
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
profiles
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
forestMappings
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
labels
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
|
proxies
array of object | null (HorizonExportableItemsSeq)
|
|||||||||||||
|
Array [
] |
|||||||||||||
-
200 The exported items
application/jsoninfoobjectcreatedAtstringversionstringitemsobject (Horizon Exportable Items)casarray of objects (Certificate Authority)Array [
_idstring (Internal ID) requiredObject internal ID
certificatestring requirednamestring requiredtrustedForClientAuthenticationboolean requiredtrustedForServerAuthenticationboolean requiredoutdatedRevocationStatusPolicystring requiredEnumrevokedunknownlastavailablestatuspublicboolean requiredsubjectKeyIdentifierstring | nullresponderUrlstring | nullcrlUrlstring | nullrefreshstring | null (FiniteDuration)timeoutstring | null (FiniteDuration)proxystring | nullcacheTimeToIdlestring | null (FiniteDuration)downloadableboolean]
pkiQueuesarray of objects (PKIQueueResponse)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requiredclusterWideboolean requiredsizeinteger requireddescriptionstring | nullthrottleDurationstring | nullthrottleParallelisminteger | null]
pkiConnectorsarray of objects (PKIResponses)rolesarray of objects (Role)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requiredThe name of the role
descriptionstring | nullThe description of the role
permissionsarray of objects | null (Permission)The role's permissions
Array [
valuestring requiredThe permission string, in the Horizon format :
: : : filterstring | nullThe filter to apply to the permission in the HPQL format
]
]
teamsarray of objects (Team)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requiredThe name of the team
managersarray of string requiredThe identifiers of the team's managers
descriptionarray of objects | null (LocalizedString)The localized description of the team
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
contactstring | nullThe generic contact e-mail of the Team
webhookobject | null (Webhook Definition)The webhook of the team's corporate channel (Teams, Slack, Mattermost)
typestring requiredThe type of the webhook (Teams or Slack/Mattermost)
Enumslackteamsurlstring requiredThe URL of the webhook
displayNamearray of objects | null (LocalizedString)The localized display name of the team
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
]
passwordPoliciesarray of objects (Password Policy)Array [
_idstring (Internal ID) requiredThe internal ID of the password policy
namestring requiredThe name of the password policy
minCharinteger requiredThe minimum number of characters of the password
maxCharinteger | nullThe maximum number of characters of the password
minUpCharinteger | nullThe minimum number of uppercase characters of the password
minLoCharinteger | nullThe minimum number of lowercase characters of the password
minDiCharinteger | nullThe minimum number of digits of the password
spCharstring | nullThe special characters of the password accepted by the password policy
minSpCharinteger | nullThe minimum number of special characters of the password
]
scimProfilesarray of objects (Scim profile)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requiredThe name of the Scim profile
descriptionstring | nullThe description of the Scim profile
mailTypestring | nullThe mail type corresponds to the mail coming from the scim provider that must be synchronised in horizon. By default, the mail type is "work".
mappingsarray of objects | nullThe mapping used to synchronize user and group between the scim provider and Horizon.
]
notificationsarray of objectsdatasourcesarray of objectsdiscoveryCampaignsarray of objects (DiscoveryCampaignResponse)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requiredThe name of the discovery campaign
authorizationLevelsobject (DiscoveryCampaignAuthorizationLevels) requiredThe authorization levels of the discovery campaign
searchobject (AuthorizationLevel) requiredThe authorization level required to search the discovered certificates of this campaign
accessLevelstring requiredThe access level required to perform the action
EnumeveryoneauthenticatedauthorizedenforcedIdentityProvidersarray of objects | null (Enforced identity providers)The different identity providers that can be enforced to perform the action
Array [
typestring requiredThe type of identity provider to be enforced
EnumLocalOpenIdX509Popnamestring requiredThe name of the identity provider to be enforced
]
feedobject (AuthorizationLevel) requiredThe authorization level required to feed certificates into this discovery campaign
accessLevelstring requiredThe access level required to perform the action
EnumeveryoneauthenticatedauthorizedenforcedIdentityProvidersarray of objects | null (Enforced identity providers)The different identity providers that can be enforced to perform the action
Array [
typestring requiredThe type of identity provider to be enforced
EnumLocalOpenIdX509Popnamestring requiredThe name of the identity provider to be enforced
]
eventOnSuccessboolean requiredWhether to log a Horizon event in case of success
eventOnWarningboolean requiredWhether to log a Horizon event in case of warning
eventOnFailureboolean requiredWhether to log a Horizon event in case of failure
enabledboolean requiredWhether the discovery campaign is enabled, i.e. whether it can be fed
descriptionstring | nullThe description of the discovery campaign
hostsarray of string | nullThe hosts to be scanned by the discovery campaign
portsarray of string | nullThe ports to be scanned by the discovery campaign
gradingPoliciesarray of string | nullThe grading policies to apply to grade the discovered certificates on this campaign
]
thirdPartiesarray of objects (ThirdPartyConnectorResponses)reportsarray of objects (ReportScheduledTaskResponse)triggersarray of objectsautomationsarray of objects (AutomationPolicyResponse)Array [
namestring required_idstring (Internal ID)Object internal ID
executionPolicystring | nullcompliancePolicyobject | null (CompliancePolicy)authorizedSigningAlgorithmsarray of string | nullauthorizedCasarray of string | nulltrustChainsarray of string | nullprofilestring]
executionsarray of objects (ExecutionPolicyResponse)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requireddescriptionstring | nullauthorizedPeriodsarray of objects | null (ExecutionPeriod)Array [
dateRangeobject | null (DateRange)startstring requiredendstring requiredweeksarray of integer | nullweekDaysarray of string | nulltimeRangestring | null]
forbiddenPeriodsarray of objects | null (ExecutionPeriod)Array [
dateRangeobject | null (DateRange)startstring requiredendstring requiredweeksarray of integer | nullweekDaysarray of string | nulltimeRangestring | null]
]
profilesarray of objects (CertificateProfileResponses)forestMappingsarray of objects (WcceForestMappingResponse)Array [
_idstring (Internal ID) requiredObject internal ID
foreststring requiredtemplateMappingsarray of objects (WcceTemplateMapping) requiredArray [
templatestring requiredprofilestring requiredenrollmentModestring requiredEnumentityeobotrust_requesteoboTrustedCasarray of string | null]
]
labelsarray of objects (LabelResponse)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requiredTechnical name of the label
displayNamearray of objects | null (LocalizedString)Display names of the label
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
descriptionarray of objects | null (LocalizedString)Localized descriptions of the label
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
]
proxiesarray of objects (Proxy)Array [
_idstring (Internal ID) requiredObject internal ID
namestring requiredName of the proxy
hoststring requiredHostname of the proxy
portinteger requiredPort of the proxy
credentialsstring | nullName of the password credentials to use for Proxy Basic Authentication
]
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCONF-EXPORT-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid export requesttitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid export requestdetailstring | 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
ValueCONF-EXPORT-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