Export configuration items

Body required

application/json

Items to export

cas

array of object | null (HorizonExportableItemsSeq)

pkiQueues

array of object | null (HorizonExportableItemsSeq)

pkiConnectors

array of object | null (HorizonExportableItemsSeq)

roles

array of object | null (HorizonExportableItemsSeq)

teams

array of object | null (HorizonExportableItemsSeq)

passwordPolicies

array of object | null (HorizonExportableItemsSeq)

scimProfiles

array of object | null (HorizonExportableItemsSeq)

notifications

array of object | null (HorizonExportableItemsSeq)

datasources

array of object | null (HorizonExportableItemsSeq)

discoveryCampaigns

array of object | null (HorizonExportableItemsSeq)

thirdParties

array of object | null (HorizonExportableItemsSeq)

reports

array of object | null (HorizonExportableItemsSeq)

triggers

array of object | null (HorizonExportableItemsSeq)

automations

array of object | null (HorizonExportableItemsSeq)

executions

array of object | null (HorizonExportableItemsSeq)

profiles

array of object | null (HorizonExportableItemsSeq)

forestMappings

array of object | null (HorizonExportableItemsSeq)

labels

array of object | null (HorizonExportableItemsSeq)

proxies

array of object | null (HorizonExportableItemsSeq)

Responses

200 The exported items

info

object

createdAt

string

version

string

items

object (Horizon Exportable Items)

cas

array of objects (Certificate Authority)

Array [

_id

string (Internal ID) required

Object internal ID

certificate

string required

name

string required

trustedForClientAuthentication

boolean required

trustedForServerAuthentication

boolean required

outdatedRevocationStatusPolicy

string required

Enum revoked unknown lastavailablestatus

public

boolean required

subjectKeyIdentifier

string | null

responderUrl

string | null

crlUrl

string | null

refresh

string | null (FiniteDuration)

timeout

string | null (FiniteDuration)

proxy

string | null

cacheTimeToIdle

string | null (FiniteDuration)

downloadable

boolean

]

pkiQueues

array of objects (PKIQueueResponse)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

clusterWide

boolean required

size

integer required

description

string | null

throttleDuration

string | null

throttleParallelism

integer | null

]

pkiConnectors

array of objects (PKIResponses)

roles

array of objects (Role)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

The name of the role

description

string | null

The description of the role

permissions

array of objects | null (Permission)

The role's permissions

]

teams

array of objects (Team)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

The name of the team

managers

array of string required

The identifiers of the team's managers

description

array of objects | null (LocalizedString)

The localized description of the team

Array [

lang

string required

The ISO 3166-1 (2-letters) code of the language used for the value

value

string required

The localized value

]

contact

string | null

The generic contact e-mail of the Team

webhook

object | null (Webhook Definition)

The webhook of the team's corporate channel (Teams, Slack, Mattermost)

type

string required

The type of the webhook (Teams or Slack/Mattermost)

Enum slack teams

url

string required

The URL of the webhook

displayName

array of objects | null (LocalizedString)

The localized display name of the team

Array [

lang

string required

The ISO 3166-1 (2-letters) code of the language used for the value

value

string required

The localized value

]

passwordPolicies

array of objects (Password Policy)

Array [

_id

string (Internal ID) required

The internal ID of the password policy

name

string required

The name of the password policy

minChar

integer required

The minimum number of characters of the password

maxChar

integer | null

The maximum number of characters of the password

minUpChar

integer | null

The minimum number of uppercase characters of the password

minLoChar

integer | null

The minimum number of lowercase characters of the password

minDiChar

integer | null

The minimum number of digits of the password

spChar

string | null

The special characters of the password accepted by the password policy

minSpChar

integer | null

The minimum number of special characters of the password

]

scimProfiles

array of objects (Scim profile)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

The name of the Scim profile

description

string | null

The description of the Scim profile

mailType

string | null

The mail type corresponds to the mail coming from the scim provider that must be synchronised in horizon. By default, the mail type is "work".

mappings

array of objects | null

The mapping used to synchronize user and group between the scim provider and Horizon.

]

notifications

array of objects

datasources

array of objects

discoveryCampaigns

array of objects (DiscoveryCampaignResponse)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

The name of the discovery campaign

authorizationLevels

object (DiscoveryCampaignAuthorizationLevels) required

The authorization levels of the discovery campaign

object (AuthorizationLevel) required

The authorization level required to search the discovered certificates of this campaign

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

The different identity providers that can be enforced to perform the action

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

feed

object (AuthorizationLevel) required

The authorization level required to feed certificates into this discovery campaign

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

The different identity providers that can be enforced to perform the action

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

eventOnSuccess

boolean required

Whether to log a Horizon event in case of success

eventOnWarning

boolean required

Whether to log a Horizon event in case of warning

eventOnFailure

boolean required

Whether to log a Horizon event in case of failure

enabled

boolean required

Whether the discovery campaign is enabled, i.e. whether it can be fed

description

string | null

The description of the discovery campaign

hosts

array of string | null

The hosts to be scanned by the discovery campaign

ports

array of string | null

The ports to be scanned by the discovery campaign

gradingPolicies

array of string | null

The grading policies to apply to grade the discovered certificates on this campaign

]

thirdParties

array of objects (ThirdPartyConnectorResponses)

reports

array of objects (ReportScheduledTaskResponse)

triggers

array of objects

automations

array of objects (AutomationPolicyResponse)

Array [

name

string required

_id

string (Internal ID)

Object internal ID

executionPolicy

string | null

compliancePolicy

object | null (CompliancePolicy)

trustChains

array of string | null

profile

string

]

executions

array of objects (ExecutionPolicyResponse)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

description

string | null

authorizedPeriods

array of objects | null (ExecutionPeriod)

forbiddenPeriods

array of objects | null (ExecutionPeriod)

]

profiles

array of objects (CertificateProfileResponses)

forestMappings

array of objects (WcceForestMappingResponse)

Array [

_id

string (Internal ID) required

Object internal ID

forest

string required

templateMappings

array of objects (WcceTemplateMapping) required

Array [

template

string required

profile

string required

enrollmentMode

string required

Enum entity eobo trust_request

eoboTrustedCas

array of string | null

]

labels

array of objects (LabelResponse)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

Technical name of the label

displayName

array of objects | null (LocalizedString)

Display names of the label

description

array of objects | null (LocalizedString)

Localized descriptions of the label

]

proxies

array of objects (Proxy)

Array [

_id

string (Internal ID) required

Object internal ID

name

string required

Name of the proxy

host

string required

Hostname of the proxy

port

integer required

Port of the proxy

credentials

string | null

Name of the password credentials to use for Proxy Basic Authentication

]

400 Bad Request

401 Unauthorized request

403 Forbidden action

500 Internal Server error

post

/api/v1/system/configurations/export

{

"cas":

[ ... ] ,

"pkiQueues":

[ ... ] ,

"pkiConnectors":

[ ... ] ,

"roles":

[ ... ] ,

"teams":

[ ... ] ,

"passwordPolicies":

[ ... ] ,

"scimProfiles":

[ ... ] ,

"notifications":

[ ... ] ,

"datasources":

[ ... ] ,

"discoveryCampaigns":

[ ... ] ,

"thirdParties":

[ ... ] ,

"reports":

[ ... ] ,

"triggers":

[ ... ] ,

"automations":

[ ... ] ,

"executions":

[ ... ] ,

"profiles":

[ ... ] ,

"forestMappings":

[ ... ] ,

"labels":

[ ... ] ,

"proxies":

[ ... ]

}