Register a new DCV provider configuration
Register a new DCV provider configuration
DCV provider configuration to register
|
name
string
requiredUnique name of the DCV provider configuration |
|
type
string
requiredProvider type discriminator
Value
DIGICERT
|
|
endpoint
string
requiredDigiCert API endpoint URL |
|
credentials
string
requiredName of the credentials configuration holding the DigiCert API key |
|
proxy
string | null
Name of the HTTP proxy configuration to use |
|
timeout
string | null (FiniteDuration)
Request timeout |
|
name
string
requiredUnique name of the DCV provider configuration |
|
type
string
requiredProvider type discriminator
Value
gs_mssl
|
|
endpoint
string
requiredGlobalSign Managed SSL (MSSL) API endpoint URL |
|
profile
string
requiredGlobalSign MSSL profile ID the domains belong to |
|
timeout
string | null (FiniteDuration)
requiredRequest timeout |
|
credentials
string
requiredName of the login/password credentials configuration holding the GlobalSign MSSL API credentials |
|
defaultEmail
string
requiredDefault contact email used when renewing a domain |
|
defaultPhone
string
requiredDefault contact phone number used when renewing a domain |
|
proxy
string
Name of the HTTP proxy configuration to use |
|
name
string
requiredUnique name of the DCV provider configuration |
|
type
string
requiredProvider type discriminator
Value
sectigo
|
|
endpoint
string
requiredSectigo Certificate Manager (SCM) API base URL |
|
dcvMethod
string
requiredDNS method used to validate a domain. It is a fallback: a domain that already holds a CNAME or TXT validation is re-validated with its own method, and this method applies only to a domain that has never been validated or whose existing validation uses a method that cannot be published over DNS.
Enum
cname
txt
|
|
timeout
string | null (FiniteDuration)
requiredRequest timeout |
|
credentials
string
requiredName of the login/password credentials configuration holding the SCM API client, with the OAuth client id as login and the client secret as password |
|
oauthTokenEndpoint
string
OAuth token endpoint used to obtain a bearer token for the SCM API. Defaults to Sectigo's SSO realm. |
|
organizationId
integer
Restricts the domain listing to this Sectigo organization or department. When unset, every domain of the customer account is listed. |
|
proxy
string
Name of the HTTP proxy configuration to use |
-
201 DCV provider configuration successfully registered
application/json_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provider configuration
typestring requiredProvider type discriminator
ValueDIGICERTendpointstring requiredDigiCert API endpoint URL
credentialsstring requiredName of the credentials configuration holding the DigiCert API key
proxystring | nullName of the HTTP proxy configuration to use
timeoutstring | null (FiniteDuration)Request timeout
_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provider configuration
typestring requiredProvider type discriminator
Valuegs_msslendpointstring requiredGlobalSign Managed SSL (MSSL) API endpoint URL
profilestring requiredGlobalSign MSSL profile ID the domains belong to
timeoutstring | null (FiniteDuration) requiredRequest timeout
credentialsstring requiredName of the login/password credentials configuration holding the GlobalSign MSSL API credentials
defaultEmailstring requiredDefault contact email used when renewing a domain
defaultPhonestring requiredDefault contact phone number used when renewing a domain
proxystringName of the HTTP proxy configuration to use
_idstring (Internal ID) requiredObject internal ID
namestring requiredUnique name of the DCV provider configuration
typestring requiredProvider type discriminator
Valuesectigoendpointstring requiredSectigo Certificate Manager (SCM) API base URL
oauthTokenEndpointstring requiredOAuth token endpoint used to obtain a bearer token for the SCM API. Defaults to Sectigo's SSO realm.
dcvMethodstring requiredDNS method used to validate a domain. It is a fallback: a domain that already holds a CNAME or TXT validation is re-validated with its own method, and this method applies only to a domain that has never been validated or whose existing validation uses a method that cannot be published over DNS.
Enumcnametxttimeoutstring | null (FiniteDuration) requiredRequest timeout
credentialsstring requiredName of the login/password credentials configuration holding the SCM API client, with the OAuth client id as login and the client secret as password
organizationIdintegerRestricts the domain listing to this Sectigo organization or department. When unset, every domain of the customer account is listed.
proxystringName of the HTTP proxy configuration to use
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueDCV-PROVIDER-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid DCV Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid DCV Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueDCV-PROVIDER-004messagestring requiredA short, human-readable summary of the problem type
ValueDCV Provider already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueDCV Provider already existsdetailstring | 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
ValueDCV-PROVIDER-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