List the existing certificate profiles

List the existing certificate profiles with the capability to filter on a list of module(s)

Query parameters

modules

array of string required

Responses

200 Certificate profile list

Array [

_id

string (Internal ID) required

Object internal ID

module

string required

Value acme

name

string required

enabled

boolean required

timeout

string required

pkiConnector

string required

authorizeShortName

boolean required

authorizeEmptyContact

boolean required

verifyRetryCount

integer required

verifyRetryDelay

string required

requireTermsOfService

boolean required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

meta

object | null (DirectoryMeta)

termsOfService

string | null

website

string | null

caaIdentities

array of string | null

externalAccountRequired

boolean | null

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

authorizationMethods

array of string | null

http01Port

integer | null

tlsAlpn01Port

integer | null

defaultContacts

array of string | null

renewalPeriod

string | null

csrDataMapping

object | null

property name*

string

additional property

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

maxDnsName

integer | null

proxy

string | null

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

Enum gs_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

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value est

name

string required

enabled

boolean required

string required

pkiConnector

string required

authorizationMode

string required

Enum authorized x509 challenge auto-validation

dnWhitelist

boolean required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

csrDataMapping

object | null

property name*

string

additional property

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

enrollAuthorizedCas

array of string | null

renewalAuthorizedCas

array of string | null

renewalPeriod

string | null

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

passwordPolicy

string | null

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

validationRuleset

object | null (Validation Ruleset)

The validation ruleset used for auto validation

rules

array of string required

The validation rules for this ruleset

threshold

integer required

Number of rules to validation in order to allow enrollment

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value intune

name

string required

enabled

boolean required

mode

string required

Enum ca ra

thirdPartyConnector

string required

pkiConnector

string required

scepRA

string required

caps

array of string required

encryptionAlgorithm

string required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

renewalPeriod

string | null

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

csrDataMapping

object | null

property name*

string

additional property

postPKIOperation

boolean | null

deviceIdField

string | null

deviceIdSeparator

string | null

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value jamf

name

string required

enabled

boolean required

mode

string required

Enum ca ra

thirdPartyConnector

string required

pkiConnector

string required

scepRA

string required

caps

array of string required

encryptionAlgorithm

string required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

renewalPeriod

string | null

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

csrDataMapping

object | null

property name*

string

additional property

postPKIOperation

boolean | null

deviceIdField

string | null

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

passwordPolicy

string | null

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value scep

name

string required

enabled

boolean required

mode

string required

Enum ca ra

scepRA

string required

caps

array of string required

encryptionAlgorithm

string required

pkiConnector

string required

dnWhitelist

boolean required

authorizationMode

string required

The 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.

Enum challenge authorized ndes auto-validation

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

postPKIOperation

boolean | null

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

renewalPeriod

string | null

csrDataMapping

object | null

property name*

string

additional property

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

passwordPolicy

string | null

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

validationRuleset

object | null (Validation Ruleset)

The validation ruleset used for auto validation

rules

array of string required

The validation rules for this ruleset

threshold

integer required

Number of rules to validation in order to allow enrollment

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value wcce

name

string required

enabled

boolean required

pkiConnector

string required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

csrDataMapping

object | null

property name*

string

additional property

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

exchangeCertificate

string | null

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value webra

name

string required

authorizationMode

string required

The 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

Enum authorized auto-validation auto-validation-authorized

enabled

boolean required

pkiConnector

string required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

csrDataMapping

object | null

property name*

string

additional property

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

renewalPeriod

string | null

gradingPolicies

array of string | null

validationRuleset

object | null (Validation Ruleset)

The validation ruleset used for auto validation

rules

array of string required

The validation rules for this ruleset

threshold

integer required

Number of rules to validation in order to allow enrollment

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value intunepkcs

name

string required

enabled

boolean required

pkiConnector

string required

thirdPartyConnector

string required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

csrDataMapping

object | null

property name*

string

additional property

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value acme-external

name

string required

enabled

boolean required

authorizationMethods

array of string | null required

pkiConnector

string required

requireEAB

boolean required

authorizedCas

array of string | null required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

acmeUrl

string

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

renewalPeriod

string | null

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

_id

string (Internal ID) required

Object internal ID

module

string required

Value crmp

name

string required

pkiConnector

string required

authorizationLevels

object (CertificateProfileAuthorizationLevels) required

revoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRevoke

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

update

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveUpdate

object (AuthorizationLevel) required

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

enrollApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveEnroll

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

recoverApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRecover

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

migrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveMigrate

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

renewApi

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

approveRenew

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

auditRequest

object | null (AuthorizationLevel)

accessLevel

string required

The access level required to perform the action

Enum everyone authenticated authorized

enforcedIdentityProviders

array of objects | null (Enforced identity providers)

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

Array [

type

string required

The type of identity provider to be enforced

Enum Local OpenId X509 Pop

name

string required

The name of the identity provider to be enforced

]

requestsPolicy

object (RequestsPolicy) required

enroll

string | null

revoke

string | null

recover

string | null

update

string | null

migrate

string | null

renew

string | null

enabled

boolean required

cryptoPolicy

object (Certificate profile crypto policy) required

centralized

boolean | null

Whether this profile supports centralized enrollment

decentralized

boolean | null

Whether this profile supports decentralized enrollment

defaultKeyType

string | null (Keytype)

Default key type used for centralized enrollment

authorizedKeyTypes

array of string | null (Keytype)

List of authorized key types for enrollment

preferredEnrollmentMode

string | null

If both centralized and decentralized enrollment are supported, this is the preferred mode

Enum centralized decentralized

escrow

boolean | null

Whether this profile will escrow the certificate private keys

p12passwordPolicy

string | null

Password policy for the P12 file

p12passwordMode

string | null

Whether the user will be required to input their PKCS#12 password upon enrollment

Enum random manual

p12storeEncryptionType

string | null

Encryption type for the P12 file

showP12PasswordOnEnroll

boolean | null

Whether the PKCS#12 password will be displayed to the user upon enrollment

showP12OnEnroll

boolean | null

Whether the PKCS#12 file will be displayed to the user upon enrollment

showP12PasswordOnRecover

boolean | null

Whether the PKCS#12 password will be displayed to the user upon recovery

showP12OnRecover

boolean | null

Whether the PKCS#12 file will be displayed to the user upon recovery

selfPermissions

object (CertificateProfileSelfPermissions) required

selfRecover

boolean | null

selfUpdate

boolean | null

selfRevoke

boolean | null

selfRenew

boolean | null

selfPopRenew

boolean | null

selfPopRevoke

boolean | null

selfPopUpdate

boolean | null

version

integer required

displayName

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

description

array of objects | null (LocalizedString)

Array [

lang

string required

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

value

string required

The localized value

]

maxCertificatePerHolderPolicy

object | null (MaxCertificatePerHolderPolicy)

max

integer required

behavior

string required

Enum revoke reject

revocationReason

string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation

triggers

object | null (CertificateProfileTriggers)

onEnroll

array of string | null

onSubmitEnroll

array of string | null

onCancelEnroll

array of string | null

onApproveEnroll

array of string | null

onDenyEnroll

array of string | null

onPendingEnroll

array of objects | null (CertificateProfileAsynchronousTrigger)

onRevoke

array of string | null

onSubmitRevoke

array of string | null

onCancelRevoke

array of string | null

onApproveRevoke

array of string | null

onDenyRevoke

array of string | null

onPendingRevoke

array of objects | null (CertificateProfileAsynchronousTrigger)

onUpdate

array of string | null

onSubmitUpdate

array of string | null

onCancelUpdate

array of string | null

onApproveUpdate

array of string | null

onDenyUpdate

array of string | null

onPendingUpdate

array of objects | null (CertificateProfileAsynchronousTrigger)

onRecover

array of string | null

onSubmitRecover

array of string | null

onCancelRecover

array of string | null

onApproveRecover

array of string | null

onDenyRecover

array of string | null

onPendingRecover

array of objects | null (CertificateProfileAsynchronousTrigger)

onMigrate

array of string | null

onSubmitMigrate

array of string | null

onCancelMigrate

array of string | null

onApproveMigrate

array of string | null

onDenyMigrate

array of string | null

onPendingMigrate

array of objects | null (CertificateProfileAsynchronousTrigger)

onExpire

array of objects | null (CertificateProfileAsynchronousTrigger)

onRenew

array of string | null

onSubmitRenew

array of string | null

onCancelRenew

array of string | null

onApproveRenew

array of string | null

onDenyRenew

array of string | null

onPendingRenew

array of objects | null (CertificateProfileAsynchronousTrigger)

dataFieldIdentifier

string | null

Only when escrow is enabled in the cryptoPolicy, possible values are: rfc822name, othername_upn, mail, uid, cn and label.. If a label is used, it should be defined in the certificateTemplate

constraints

object | null (CertificateRequestConstraints)

allowedDomains

string | null

allowedEmailDomains

string | null

allowedDnsDomains

string | null

certificateTemplate

object | null (CertificateTemplate)

subject

array of objects | null (DNElement)

Array [

type

string required

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

sans

array of objects | null (SANElement)

Array [

type

string required

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

min

integer | null

max

integer | null

]

extensions

array of objects | null (ExtensionElement)

Array [

type

string required

Enum ms_sid ms_template

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

]

ownerPolicy

object | null (OwnerPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

teamPolicy

object | null (TeamPolicy)

editableByRequester

boolean required

editableByApprover

boolean required

mandatory

boolean required

regex

string | null

whitelist

array of string | null

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

description

array of objects | null (LocalizedString)

metadataPolicies

array of objects | null (MetadataPolicy)

Array [

metadata

string required

editableByRequester

boolean required

editableByApprover

boolean required

]

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

value

string | null

The default value of the label element

computationRule

string | null (Computation Rule)

The computation rule of the label element

mandatory

boolean | null

Whether the label element is mandatory to submit a request

editableByRequester

boolean | null

Whether the label element is editable by the requester

editableByApprover

boolean | null

Whether the label element is editable by the approver

regex

string | null

The regex used to validate the label element

enum

array of string | null

The whitelist used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmailPolicy

object | null (ContactEmailPolicy)

mandatory

boolean required

value

string | null

computationRule

string | null (Computation Rule)

A computation rule that will dynamically generate a string value from the request's context

editableByRequester

boolean | null

editableByApprover

boolean | null

regex

string | null

whitelist

array of string | null

description

array of objects | null (LocalizedString)

gradingPolicies

array of string | null

dsFlow

array of object | null (Datasource Flow)

Representation of a datasource execution flow

Array [

string required

Name of the datasource to execute for this step

inputs

array of object | null (Datasource Input)

List of inputs to use for this datasource

stopOnSuccess

boolean

Stop the flow if this datasource is successfully executed

]

204 No certificate profile defined or insufficient permissions

400 Bad Request

401 Unauthorized request

403 Forbidden action

500 Internal Server error

get

/api/v1/certificate/profiles