Update an existing PKI connector
Update an existing PKI connector
PKI connector to update
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
stream
|
|
endPoint
string
requiredStream's base endpoint |
|
template
string
requiredStream's certificate template to use for enrollment |
|
ca
string
requiredStream'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. Only one of loginCredentials and authenticationCredentials can be specified. |
|
authenticationCredentials
string | null
Name of the certificate credentials to use to authenticate on the PKI. Only one of loginCredentials and authenticationCredentials can be specified. |
|
timeout
string | null
|
|
proxy
string | null
|
|
queue
string | null
|
|
_id
string
required |
|
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
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
certeurope
|
|
endPoint
string
required |
|
loginCredentials
string
requiredName of the password credentials to use for technical account on the PKI |
|
offerId
string
required |
|
organizationId
string
required |
|
authenticationCredentials
string
requiredName 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
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
cmp
|
|
endPoint
string
required |
|
profile
string
required |
|
issuerCADN
string
required |
|
issuerCACert
string
required |
|
signerCredentials
string
requiredName of the certificate credentials to use to sign on the PKI |
|
authenticationCredentials
string
requiredName 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
|
|
_id
string
required |
||
|
name
string
required |
||
|
type
string
required
Value
digicert
|
||
|
endPoint
string
required |
||
|
apiCredentials
string
requiredName of the raw credentials containing the API key to authenticate on the PKI |
||
|
organizationId
integer
required |
||
|
caCertId
string | null
|
||
|
retryInterval
string | null
|
||
|
skipApproval
boolean | null
|
||
|
customConnectorDataMapping
object | null
|
||
|
||
|
timeout
string | null
|
||
|
proxy
string | null
|
||
|
queue
string | null
|
||
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
ejbca
|
|
endPoint
string
required |
|
profile
string
required |
|
caName
string
required |
|
authenticationCredentials
string
requiredName of the certificate credentials to use to authenticate on the PKI |
|
eeProfile
string | null
|
|
timeout
string | null
|
|
proxy
string | null
|
|
queue
string | null
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
entrust
|
|
loginCredentials
string
requiredName of the password credentials to use for technical account on the PKI |
|
certType
string
required |
|
requesterDefaultMail
string
required |
|
authenticationCredentials
string
requiredName 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
|
|
_id
string
required |
||
|
name
string
required |
||
|
type
string
required
Value
integrated
|
||
|
caKey
object | null (models.secret.SecretString)
|
||
|
||
|
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
|
||
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
fcms
|
|
endPoint
string
required |
|
apiCredentials
string
requiredName 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
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
gsatlas
|
|
loginCredentials
string
requiredName of the password credentials to use for technical account on the PKI |
|
authenticationCredentials
string
requiredName 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
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
gsmssl
|
|
endpointType
string
required |
|
profile
string
required |
|
loginCredentials
string
requiredName 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
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
otpki
|
|
endPoint
string
required |
|
profile
string
required |
|
authenticationCredentials
string
requiredName 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
|
|
timeout
string | null
|
|
proxy
string | null
|
|
queue
string | null
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
msadcs
|
|
endPoint
string
required |
|
profile
string
required |
|
loginCredentials
string
requiredName of the password credentials to use for technical account on the PKI |
|
enrollmentCredentials
string
requiredName of the certificate credentials to use to enroll on the PKI |
|
timeout
string | null
|
|
proxy
string | null
|
|
queue
string | null
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
evtadcs
|
|
endPoint
string
required |
|
caConfig
string
required |
|
profile
string
required |
|
domain
string
required |
|
loginCredentials
string
requiredName of the password credentials to use for technical account on the PKI |
|
enrollmentCredentials
string
requiredName of the certificate credentials to use to enroll on the PKI |
|
timeout
string | null
|
|
proxy
string | null
|
|
queue
string | null
|
|
_id
string
required |
|
name
string
required |
|
type
string
required
Value
nexuscm
|
|
endPoint
string
required |
|
endPointIssuingCA
string
required |
|
procedure
string
required |
|
authenticationCredentials
string
requiredName of the certificate credentials to use to authenticate on the PKI |
|
timeout
string | null
|
|
proxy
string | null
|
|
queue
string | null
|
-
200 PKI connector successfully updated
application/json_idstring requirednamestring requiredtypestring requiredValuestreamendPointstring requiredStream's base endpoint
templatestring requiredStream's certificate template to use for enrollment
castring requiredStream's technical name of the CA on which to enroll
loginCredentialsstring | nullName of the password credentials to use to authenticate on the PKI. Only one of loginCredentials and authenticationCredentials can be specified.
authenticationCredentialsstring | nullName of the certificate credentials to use to authenticate on the PKI. Only one of loginCredentials and authenticationCredentials can be specified.
timeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValueawsacmpcaregionstring requiredcaArnstring requiredaccessCredentialsstring | nullName of the password credentials containing Access Key Id and Secret Access Key. If not defined, an account present in environment variables can be used.
templateArnstring | nullroleArnstring | nullvalidDaysstring | nullretryIntervalstring | nullsigningHashstring | nullcertificateUsagestring | nullcaPolicyOidstring | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuecerteuropeendPointstring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
offerIdstring requiredorganizationIdstring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
revReasonstring | nullretryIntervalstring | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuecmpendPointstring requiredprofilestring requiredissuerCADNstring requiredissuerCACertstring requiredsignerCredentialsstring requiredName of the certificate credentials to use to sign on the PKI
authenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
emailMapstring | nullsanDnsMapstring | nullcnMapstring | nullprofileMapstring | nullissuerMapstring | nulllegacyCMPStyleboolean | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuedigicertendPointstring requiredapiCredentialsstring requiredName of the raw credentials containing the API key to authenticate on the PKI
organizationIdinteger requiredcaCertIdstring | nullretryIntervalstring | nullskipApprovalboolean | nullcustomConnectorDataMappingobject | nullproperty name*stringadditional propertytimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValueejbcaendPointstring requiredprofilestring requiredcaNamestring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
eeProfilestring | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValueentrustloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
certTypestring requiredrequesterDefaultMailstring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
requesterNamestring | nullrequesterPhonestring | nullcertLifetimestring | nullclientIdinteger | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValueintegratedcaKeyobject | null (models.secret.SecretString)valuestring | nullValue of the secret that will be passed to Horizon
caCertstring | nullcrlPathstring | nullcrlLifetimestring | nullcertTypestring | nullsignAlgstring | nullcrtLifetimestring | nullcrtBackDatestring | nullcheckPopboolean | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuefcmsendPointstring requiredapiCredentialsstring requiredName of the raw credentials containing the API key to authenticate on the PKI
templateIdinteger requireddefaultOwnerstring requiredauthenticationDomainIdinteger requireddeleteOnRevokeboolean requiredownerGroupsstring | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuegsatlasloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
authenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
hashAlgorithmstring | nullcertificateUsagestring | nullretryIntervalstring | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuegsmsslendpointTypestring requiredprofilestring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
domainIdstring requiredcertificateValidityinteger | nulldefaultEmailstring | nulldefaultPhonestring | nullretryIntervalstring | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValueotpkiendPointstring requiredprofilestring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
emailMapstring | nullsanDnsMapstring | nullsanEmailMapstring | nulluidMapstring | nullzonestring | nulltimeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuemsadcsendPointstring requiredprofilestring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
enrollmentCredentialsstring requiredName of the certificate credentials to use to enroll on the PKI
timeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValueevtadcsendPointstring requiredcaConfigstring requiredprofilestring requireddomainstring requiredloginCredentialsstring requiredName of the password credentials to use for technical account on the PKI
enrollmentCredentialsstring requiredName of the certificate credentials to use to enroll on the PKI
timeoutstring | nullproxystring | nullqueuestring | null_idstring requirednamestring requiredtypestring requiredValuenexuscmendPointstring requiredendPointIssuingCAstring requiredprocedurestring requiredauthenticationCredentialsstring requiredName of the certificate credentials to use to authenticate on the PKI
timeoutstring | nullproxystring | nullqueuestring | null -
400 Bad Request
application/jsonerrorstring requiredThe error code of the problem
ValuePKI-CONNECTOR-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid PKI Connectortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid PKI Connectordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/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 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
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/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
-
404 Not Found
application/jsonerrorstring requiredThe error code of the problem
ValuePKI-CONNECTOR-003messagestring requiredA short, human-readable summary of the problem type
ValuePKI Connector not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePKI Connector not founddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/jsonerrorstring requiredThe error code of the problem
ValuePKI-CONNECTOR-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