Retrieve an existing PKI connector :: EVERTRUST documentation

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value stream

endPoint

string required

Stream's base endpoint

template

string required

Stream's certificate template to use for enrollment

ca

string required

Stream's technical name of the CA on which to enroll

loginCredentials

string | null

Name of the password credentials to use to authenticate on the PKI

authenticationCredentials

string | null

Name of the certificate credentials to use to authenticate on the PKI

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value acmeenroll

endPoint

string required

The directory url of the ACME endpoint

timeout

string | null (FiniteDuration) required

accountKeyType

string (Keytype) required

The key type to use to generate the account key

status

object | null (PKI Connector status) required

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

accountUrl

string required

Url of the account on the ACME directory

dnsChallengeProvider

object (Manual DNS Challenge Provider) | object (Nameshield DNS Challenge Provider) required

DNS Provider configuration to provision the DNS challenge. Available from 2.7.7

type

string required

Value manual

setTrigger

object (ACME REST Request) required

The trigger that will set the DNS challenge on the provider. Available before 2.7.10

url

string (TemplateString) required

The url to request

method

string required

The HTTP method to use for the request

authenticationType

string required

The authentication type to use while making the REST call. Is linked to credentials.

Enum noauth basic x509 bearer custom

expectedHttpCodes

array of integer required

The success HTTP codes for the request. If the return code is not in this list, the notification will be considered failed.

timeout

string required

Timeout for the HTTP request.

credentials

string | null

Name of the credentials to use for authentication

headers

array of object | null (Header)

The headers of the request

Array [

name

string required

The header name

value

string required

The header value

]

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

unsetTrigger

object (ACME REST Request)

The trigger that will unset the DNS challenge on the provider. Available before 2.7.10

url

string (TemplateString) required

The url to request

method

string required

The HTTP method to use for the request

authenticationType

string required

The authentication type to use while making the REST call. Is linked to credentials.

Enum noauth basic x509 bearer custom

expectedHttpCodes

array of integer required

The success HTTP codes for the request. If the return code is not in this list, the notification will be considered failed.

timeout

string required

Timeout for the HTTP request.

credentials

string | null

Name of the credentials to use for authentication

headers

array of object | null (Header)

The headers of the request

Array [

name

string required

The header name

value

string required

The header value

]

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

setTriggers

array of objects (ACME REST Request)

The triggers that will set the DNS challenge on the provider. Available from 2.7.10

Array [

url

string (TemplateString) required

The url to request

method

string required

The HTTP method to use for the request

authenticationType

string required

The authentication type to use while making the REST call. Is linked to credentials.

Enum noauth basic x509 bearer custom

expectedHttpCodes

array of integer required

The success HTTP codes for the request. If the return code is not in this list, the notification will be considered failed.

timeout

string required

Timeout for the HTTP request.

credentials

string | null

Name of the credentials to use for authentication

headers

array of object | null (Header)

The headers of the request

Array [

name

string required

The header name

value

string required

The header value

]

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

]

unsetTriggers

array of objects (ACME REST Request)

The triggers that will unset the DNS challenge on the provider. Available from 2.7.10

Array [

url

string (TemplateString) required

The url to request

method

string required

The HTTP method to use for the request

authenticationType

string required

The authentication type to use while making the REST call. Is linked to credentials.

Enum noauth basic x509 bearer custom

expectedHttpCodes

array of integer required

The success HTTP codes for the request. If the return code is not in this list, the notification will be considered failed.

timeout

string required

Timeout for the HTTP request.

credentials

string | null

Name of the credentials to use for authentication

headers

array of object | null (Header)

The headers of the request

Array [

name

string required

The header name

value

string required

The header value

]

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

]

proxy

string | null

queue

string | null

eab

string | null

password credentials name to use for External Account Binding

accountEmail

string | null

Email to associate with the account

rotateAccount

boolean | null

If enable, regenerate the account (does not need to be specified on creation)

domainDictionaryProvider

object (Static Domain Dictionary Provider) | null

The dictionary provider

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value acmerevoke

acmeDirectoryUrl

string required

The directory url of the ACME endpoint

status

object | null (PKI Connector status) required

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

timeout

string | null (FiniteDuration)

proxy

string | null

queue

string | null

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value evtadcs

endPoint

string required

caConfig

string required

profile

string required

domain

string required

loginCredentials

string required

Name of the password credentials to use for technical account on the PKI

enrollmentCredentials

string required

Name of the certificate credentials to use to enroll on the PKI

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value msadcs

endPoint

string required

profile

string required

loginCredentials

string required

Name of the password credentials to use for technical account on the PKI

enrollmentCredentials

string required

Name of the certificate credentials to use to enroll on the PKI

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value awsacmpca

region

string required

caArn

string required

accessCredentials

string | null

Name of the password credentials containing Access Key Id and Secret Access Key. If not defined, an account present in environment variables can be used.

templateArn

string | null

roleArn

string | null

validDays

string | null

retryInterval

string | null

signingHash

string | null

certificateUsage

string | null

caPolicyOid

string | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value certeurope

endPoint

string required

loginCredentials

string required

Name of the password credentials to use for technical account on the PKI

offerId

string required

organizationId

string required

authenticationCredentials

string required

Name of the certificate credentials to use to authenticate on the PKI

revReason

string | null

retryInterval

string | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value cmp

endPoint

string required

profile

string required

issuerCADN

string required

issuerCACert

string required

signerCredentials

string required

Name of the certificate credentials to use to sign on the PKI

authenticationCredentials

string required

Name of the certificate credentials to use to authenticate on the PKI

emailMap

string | null

sanDnsMap

string | null

cnMap

string | null

profileMap

string | null

issuerMap

string | null

legacyCMPStyle

boolean | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value digicert

apiCredentials

string required

Name of the raw credentials containing the API key to authenticate on the PKI

organizationId

integer required

baseUrl

string

The base URL of the used digicert instance.

Enum https://www.digicert.com/ https://certcentral.digicert.eu/

productId

string

One of the DigiCert product identifier an exhaustive list can be found here: https://dev.digicert.com/en/certcentral-apis/services-api/glossary.html#product-identifiers

caCertId

string | null

retryInterval

string | null

skipApproval

boolean | null

customConnectorDataMapping

object | null

property name*

string

additional property

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value ejbca

endPoint

string required

profile

string required

caName

string required

authenticationCredentials

string required

Name of the certificate credentials to use to authenticate on the PKI

eeProfile

string | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value entrust

loginCredentials

string required

Name of the password credentials to use for technical account on the PKI

certType

string required

requesterDefaultMail

string required

authenticationCredentials

string required

Name of the certificate credentials to use to authenticate on the PKI

requesterName

string | null

requesterPhone

string | null

certLifetime

string | null

clientId

integer | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value idca

endPoint

string required

profile

string required

authenticationCredentials

string | null required

Name of the certificate credentials to use to authenticate on the PKI

timeout

string | null (FiniteDuration)

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value integrated

cryptoType

string required

Enum legacy hybrid pqc

caKey

object | null (SecretString)

value

string | null

Value of the secret that will be passed to Horizon

caCert

string | null

crlPath

string | null

crlLifetime

string | null

certType

string | null

signAlg

string | null

crtLifetime

string | null

crtBackDate

string | null

checkPop

boolean | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value fcms

endPoint

string required

apiCredentials

string required

Name of the raw credentials containing the API key to authenticate on the PKI

templateId

integer required

defaultOwner

string required

authenticationDomainId

integer required

deleteOnRevoke

boolean required

ownerGroups

string | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value gsatlas

loginCredentials

string required

Name of the password credentials to use for technical account on the PKI

authenticationCredentials

string required

Name of the certificate credentials to use to authenticate on the PKI

hashAlgorithm

string | null

certificateUsage

string | null

retryInterval

string | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value gsmssl

endpointType

string required

profile

string required

loginCredentials

string required

Name of the password credentials to use for technical account on the PKI

domainId

string required

certificateValidity

integer | null

defaultEmail

string | null

defaultPhone

string | null

retryInterval

string | null

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value otpki

endPoint

string required

profile

string required

authenticationCredentials

string required

Name of the certificate credentials to use to authenticate on the PKI

emailMap

string | null

sanDnsMap

string | null

sanEmailMap

string | null

uidMap

string | null

zone

string | null

zoneLabel

string | null

The name of the label where the zone value is stored on an enrolled certificate

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value metapki

endPoint

string required

MetaPKI base endpoint

endPointIssuingCA

string required

Certificate authority of the endpoint

profile

string required

workflow

string | null required

profilCle

string | null required

validDays

string | null (FiniteDuration)

formPorteurName

string | null

authenticationCredentials

string | null

Name of the certificate credentials to use to authenticate on the PKI

timeout

string | null (FiniteDuration)

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value nameshield

apiCredentials

string required

Name of the api-key credentials to use to authenticate on the PKI

environment

string required

The testing environment will use https://ote-api.nameshield.net endpoint and the production will use https://api.nameshield.net

Enum production testing

organizationId

string required

productId

string required

customerId

string required

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value nexuscm

endPoint

string required

endPointIssuingCA

string required

procedure

string required

authenticationCredentials

string required

Name of the certificate credentials to use to authenticate on the PKI

timeout

string | null

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value sectigo

loginCredentials

string required

Name of the password credentials to use to authenticate on the PKI

customerUri

string required

organizationId

integer required

profile

string required

retryInterval

string | null (FiniteDuration)

validDays

string | null (FiniteDuration)

endpointType

string

Enum eu hard default

timeout

string | null (FiniteDuration)

proxy

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)

_id

string (Internal ID) required

Object internal ID

name

string required

type

string required

Value swisssign

mpkiCredentials

string required

Name of the password credentials to use to authenticate on the PKI. It should contains the mpkiId as the login and the apiKey as password.

endPoint

string required

Swiss base endpoint

productUuid

string required

The product Uuid that need to be retrieved from the swiss sign api's (/v2/clients)

proxy

string | null

timeout

string | null

queue

string | null

status

object | null (PKI Connector status)

The status of a pki connector

lastCheck

integer required

The date, in milliseconds since the epoch, of the last time the pki connector health check was ran.

status

string required

The status of the pki connector connection. The 'unknown' status means that the healthcheck is not available.

Enum success failure unknown running

message

string | null

A meaningful message about the result of the health check (in case of error)