Retrieve a specific certificate profile
Retrieve a specific certificate profile based on its name
name
string
required |
-
200 The certificate profile
application/json_idstring (Internal ID) requiredObject internal ID
modulestring requiredValueacme
namestring requiredenabledboolean requiredtimeoutstring requiredpkiConnectorstring requiredauthorizeShortNameboolean requiredauthorizeEmptyContactboolean requiredverifyRetryCountinteger requiredverifyRetryDelaystring requiredrequireTermsOfServiceboolean requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullselfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
displayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metaobject | null (DirectoryMeta)termsOfServicestring | nullwebsitestring | nullcaaIdentitiesarray of string | nullexternalAccountRequiredboolean | nullconstraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullauthorizationMethodsarray of string | nullhttp01Portinteger | nulltlsAlpn01Portinteger | nulldefaultContactsarray of string | nullrenewalPeriodstring | nullcsrDataMappingobject | nullproperty name*stringadditional propertymaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
maxDnsNameinteger | nullproxystring | nulltriggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
certificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nulldsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValueest
namestring requiredenabledboolean requiredcastring requiredpkiConnectorstring requiredauthorizationModestring requiredEnumauthorized
x509
challenge
auto-validation
dnWhitelistboolean requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
selfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nulldisplayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
constraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullcsrDataMappingobject | nullproperty name*stringadditional propertymaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
enrollAuthorizedCasarray of string | nullrenewalAuthorizedCasarray of string | nullrenewalPeriodstring | nulltriggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
passwordPolicystring | nullcertificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nullvalidationRulesetobject | null (Validation Ruleset)The validation ruleset used for auto validation
rulesarray of string requiredThe validation rules for this ruleset
thresholdinteger requiredNumber of rules to validation in order to allow enrollment
dsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValueintune
namestring requiredenabledboolean requiredmodestring requiredEnumca
ra
thirdPartyConnectorstring requiredpkiConnectorstring requiredscepRAstring requiredcapsarray of string requiredencryptionAlgorithmstring requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullselfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
displayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
renewalPeriodstring | nullconstraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullcsrDataMappingobject | nullproperty name*stringadditional propertypostPKIOperationboolean | nulldeviceIdFieldstring | nulldeviceIdSeparatorstring | nullmaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
triggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
certificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nulldsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValuejamf
namestring requiredenabledboolean requiredmodestring requiredEnumca
ra
thirdPartyConnectorstring requiredpkiConnectorstring requiredscepRAstring requiredcapsarray of string requiredencryptionAlgorithmstring requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullselfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
displayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
renewalPeriodstring | nullconstraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullcsrDataMappingobject | nullproperty name*stringadditional propertypostPKIOperationboolean | nulldeviceIdFieldstring | nullmaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
triggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
passwordPolicystring | nullcertificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nulldsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValuescep
namestring requiredenabledboolean requiredmodestring requiredEnumca
ra
scepRAstring requiredcapsarray of string requiredencryptionAlgorithmstring requiredpkiConnectorstring requireddnWhitelistboolean requiredauthorizationModestring requiredThe authorization mode for this profile:
- challenge: a SCEP challenge must be used when submitting a request.
- authorized: the challenge does not come from the challenge but are credentials 'login:password' hex encoded of an account with enroll permissions.
- ndes: challenge requests are automatically generated by an account with enroll permissions.
Enumchallenge
authorized
ndes
auto-validation
authorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullselfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
displayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
postPKIOperationboolean | nullconstraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullrenewalPeriodstring | nullcsrDataMappingobject | nullproperty name*stringadditional propertymaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
triggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
passwordPolicystring | nullcertificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nullvalidationRulesetobject | null (Validation Ruleset)The validation ruleset used for auto validation
rulesarray of string requiredThe validation rules for this ruleset
thresholdinteger requiredNumber of rules to validation in order to allow enrollment
dsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValuewcce
namestring requiredenabledboolean requiredpkiConnectorstring requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullselfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
displayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
constraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullcsrDataMappingobject | nullproperty name*stringadditional propertymaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
triggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
certificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nullexchangeCertificatestring | nulldsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValuewebra
namestring requiredauthorizationModestring requiredThe authorization mode to use. authorized uses permissions to allow enrollment, auto-validation uses the validation ruleset, auto-validation-authorized uses the validation ruleset, and if enrollment is denied, uses the permissions
Enumauthorized
auto-validation
auto-validation-authorized
enabledboolean requiredpkiConnectorstring requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
selfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nulldisplayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
csrDataMappingobject | nullproperty name*stringadditional propertymaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
triggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
certificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
renewalPeriodstring | nullgradingPoliciesarray of string | nullvalidationRulesetobject | null (Validation Ruleset)The validation ruleset used for auto validation
rulesarray of string requiredThe validation rules for this ruleset
thresholdinteger requiredNumber of rules to validation in order to allow enrollment
dsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValueintunepkcs
namestring requiredenabledboolean requiredpkiConnectorstring requiredthirdPartyConnectorstring requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
selfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nulldisplayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
constraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullcsrDataMappingobject | nullproperty name*stringadditional propertymaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
triggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
certificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nulldsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
_idstring (Internal ID) requiredObject internal ID
modulestring requiredValueacme-external
namestring requiredenabledboolean requiredauthorizationMethodsarray of string | null requiredpkiConnectorstring requiredrequireEABboolean requiredauthorizedCasarray of string | null requiredauthorizationLevelsobject (CertificateProfileAuthorizationLevels) requiredrevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRevokeobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
searchobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
updateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveUpdateobject (AuthorizationLevel) requiredaccessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
enrollApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveEnrollobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
recoverApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRecoverobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
migrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveMigrateobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
renewApiobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
approveRenewobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
auditRequestobject | null (AuthorizationLevel)accessLevelstring requiredThe access level required to perform the action
Enumeveryone
authenticated
authorized
enforcedIdentityProvidersarray 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
EnumLocal
OpenId
X509
Pop
namestring requiredThe name of the identity provider to be enforced
]
requestsPolicyobject (RequestsPolicy) requiredenrollstring | nullrevokestring | nullrecoverstring | nullupdatestring | nullmigratestring | nullrenewstring | nullselfPermissionsobject (CertificateProfileSelfPermissions) requiredselfRecoverboolean | nullselfUpdateboolean | nullselfRevokeboolean | nullselfRenewboolean | nullselfPopRenewboolean | nullselfPopRevokeboolean | nullselfPopUpdateboolean | nullcryptoPolicyobject (Certificate profile crypto policy) requiredcentralizedboolean | nullWhether this profile supports centralized enrollment
decentralizedboolean | nullWhether this profile supports decentralized enrollment
defaultKeyTypestring | null (Keytype)Default key type used for centralized enrollment
authorizedKeyTypesarray of string | null (Keytype)List of authorized key types for enrollment
preferredEnrollmentModestring | nullIf both centralized and decentralized enrollment are supported, this is the preferred mode
Enumcentralized
decentralized
escrowboolean | nullWhether this profile will escrow the certificate private keys
p12passwordPolicystring | nullPassword policy for the P12 file
p12passwordModestring | nullWhether the user will be required to input their PKCS#12 password upon enrollment
Enumrandom
manual
p12storeEncryptionTypestring | nullEncryption type for the P12 file
showP12PasswordOnEnrollboolean | nullWhether the PKCS#12 password will be displayed to the user upon enrollment
showP12OnEnrollboolean | nullWhether the PKCS#12 file will be displayed to the user upon enrollment
showP12PasswordOnRecoverboolean | nullWhether the PKCS#12 password will be displayed to the user upon recovery
showP12OnRecoverboolean | nullWhether the PKCS#12 file will be displayed to the user upon recovery
displayNamearray of objects | null (LocalizedString)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)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
constraintsobject | null (CertificateRequestConstraints)allowedDomainsstring | nullallowedEmailDomainsstring | nullallowedDnsDomainsstring | nullacmeUrlstringmaxCertificatePerHolderPolicyobject | null (MaxCertificatePerHolderPolicy)maxinteger requiredbehaviorstring requiredEnumrevoke
reject
revocationReasonstring | null (Revocation Reason)One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
renewalPeriodstring | nulltriggersobject | null (CertificateProfileTriggers)onEnrollarray of string | nullonSubmitEnrollarray of string | nullonCancelEnrollarray of string | nullonApproveEnrollarray of string | nullonDenyEnrollarray of string | nullonPendingEnrollarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRevokearray of string | nullonSubmitRevokearray of string | nullonCancelRevokearray of string | nullonApproveRevokearray of string | nullonDenyRevokearray of string | nullonPendingRevokearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onUpdatearray of string | nullonSubmitUpdatearray of string | nullonCancelUpdatearray of string | nullonApproveUpdatearray of string | nullonDenyUpdatearray of string | nullonPendingUpdatearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRecoverarray of string | nullonSubmitRecoverarray of string | nullonCancelRecoverarray of string | nullonApproveRecoverarray of string | nullonDenyRecoverarray of string | nullonPendingRecoverarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onMigratearray of string | nullonSubmitMigratearray of string | nullonCancelMigratearray of string | nullonApproveMigratearray of string | nullonDenyMigratearray of string | nullonPendingMigratearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onExpirearray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
onRenewarray of string | nullonSubmitRenewarray of string | nullonCancelRenewarray of string | nullonApproveRenewarray of string | nullonDenyRenewarray of string | nullonPendingRenewarray of objects | null (CertificateProfileAsynchronousTrigger)Array [
namestring requiredactivationDateinteger | null]
certificateTemplateobject | null (CertificateTemplate)subjectarray of objects | null (DNElement)Array [
typestring requiredmandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
sansarray of objects | null (SANElement)Array [
typestring requiredEnumRFC822NAME
DNSNAME
URI
IPADDRESS
OTHERNAME_UPN
OTHERNAME_GUID
REGISTERED_ID
computationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullmininteger | nullmaxinteger | null]
extensionsarray of objects | null (ExtensionElement)Array [
typestring requiredEnumms_sid
ms_template
mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | null]
ownerPolicyobject | null (OwnerPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
teamPolicyobject | null (TeamPolicy)editableByRequesterboolean requirededitableByApproverboolean requiredmandatoryboolean requiredregexstring | nullwhitelistarray of string | nullvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
descriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
metadataPoliciesarray of objects | null (MetadataPolicy)Array [
metadatastring requiredEnumgs_order_id
renewed_certificate_id
metapki_id
pki_connector
digicert_id
entrust_id
scep_transid
fcms_id
previous_certificate_id
gsatlas_id
certeurope_id
digicert_order_id
automation_policy
contact_email
editableByRequesterboolean requirededitableByApproverboolean required]
labelsarray of objects | null (Label)Array [
labelstring requiredThe name of the label
valuestring | nullThe default value of the label element
computationRulestring | null (Computation Rule)The computation rule of the label element
mandatoryboolean | nullWhether the label element is mandatory to submit a request
editableByRequesterboolean | nullWhether the label element is editable by the requester
editableByApproverboolean | nullWhether the label element is editable by the approver
regexstring | nullThe regex used to validate the label element
enumarray of string | nullThe whitelist used to validate the label element
suggestionsarray of string | nullThe suggestions used to recommend the label element values
]
contactEmailPolicyobject | null (ContactEmailPolicy)mandatoryboolean requiredvaluestring | nullcomputationRulestring | null (Computation Rule)A computation rule that will dynamically generate a string value from the request's context
editableByRequesterboolean | nulleditableByApproverboolean | nullregexstring | nullwhitelistarray of string | nulldescriptionarray of objects | null (LocalizedString)Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
gradingPoliciesarray of string | nulldsFlowarray of object | null (Datasource Flow)Representation of a datasource execution flow
Array [
dsstring requiredName of the datasource to execute for this step
inputsarray of object | null (Datasource Input)List of inputs to use for this datasource
Array [
keystring requiredName of the datasource to execute for this step
valuestring (Computation Rule)Value for this input
]
stopOnSuccessbooleanStop the flow if this datasource is successfully executed
]
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001
messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Error
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Error
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002
messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not exist
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not exist
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trusted
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusted
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expired
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expired
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revoked
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revoked
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006
messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007
messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Provider
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Provider
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008
messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect path
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect path
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009
messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expired
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expired
detailstring | 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-001
messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privileges
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privileges
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002
messagestring requiredA short, human-readable summary of the problem type
ValueInvalid License
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid License
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004
messagestring requiredA short, human-readable summary of the problem type
ValueExpired License
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired License
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
404 Not Found
application/problem+jsonerrorstring requiredThe error code of the problem
ValueCERT-PROFILE-003
messagestring requiredA short, human-readable summary of the problem type
ValueCertificate Profile not found
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate Profile not found
detailstring | 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
ValueCERT-PROFILE-001
messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Error
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Error
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001
messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Error
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Error
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001
messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected error
titlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected error
detailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807