Retrieve a request template

Retrieve the template to fulfill a specific request. The template indicates the required element to include when submitting a new request

Query parameters

termsOfService

boolean

If true, include the Terms of Service entry configured on the profile in the response. Only applies to WebRA, EST and SCEP enroll requests.

Body required

application/json

The request on which to return the template

Responses

200 The request including the template

workflow

string required

The request workflow

Value enroll

module

string required

The module for which to return the template.

Value webra

profile

string (Certificate profile) required

The profile for which to return the template.

template

object (WebRA Enroll Request Template) required

The template with the constraint set on the profile

subject

array of objects | null (IndexedDNElement)

List of DN elements that will be used to build the certificate's Distinguished Name

Array [

element

string required

The element type and index. Indexes start at 1! Available elements are: cn, e, ou, st, l, o, c, dc, uid, serialNumber, surname, givenName, unstructuredAddress, unstructuredName, organizationIdentifier, uniqueIdentifier, street, description, t

type

string | null

The formatted element type

Enum CN E OU ST L O C DC UID SERIALNUMBER SURNAME GIVENNAME unstructuredAddress unstructuredName organizationIdentifier UniqueIdentifier STREET DESCRIPTION T

value

string | null

The element value

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

mandatory

boolean | null

Whether the field is mandatory or not

editable

boolean | null

Whether the field is editable or not for the currently authenticated user

regex

string | null

A regular expression that will be used to validate the element's value

]

sans

array of objects | null (SAN Element)

List of SAN elements that will be used to build the certificate's Subject Alternative Name

Array [

type

string | null required

SAN type

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

value

array of string | null

SAN value

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether this SAN element is editable by the user

regex

string | null

The regex that will be used to validate the SAN value

min

integer | null

The minimum number of SAN elements that must be provided

max

integer | null

The maximum number of SAN elements that can be provided

]

extensions

array of objects | null (Certificate Extension)

Information about the certificate's extensions and how to edit them

Array [

type

string required

The type of the extension element

Enum ms_sid ms_template ms_template_v2

value

string | null

The value of the extension element

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the extension element is editable by the requester

regex

string | null

The regular expression to validate the extension element

mandatory

boolean | null

Whether the extension element is mandatory to submit this request

]

labels

array of objects | null (Label)

List of labels used internally to tag and group certificates

Array [

label

string required

The name of the label

displayName

array of objects | null (LocalizedString)

The display name of the label element

description

array of objects | null (LocalizedString)

The description of the label element

value

string | null

The 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 this request

editable

boolean | null

Whether the label element is editable

regex

string | null

The regex used to validate the label element

enum

array of string | null

The enum used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

contactEmail

object | null (Contact email)

Information about the certificate's contact email and how to edit it

value

string | null

The contact email

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the contact email is editable by the requester

mandatory

boolean | null

Whether the contact email is mandatory to submit this request

regex

string | null

The regular expression to validate the contact email

whitelist

array of string | null

The list of allowed contact emails

description

array of objects | null (LocalizedString)

The description of the contact email

owner

object | null (Certificate Owner)

Information about the certificate's owner and how to edit it

value

string | null

The value of the owner element. This should be a principal identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the owner element is editable by the requester

mandatory

boolean | null

Whether the owner element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the owner element

team

object | null (Certificate Team)

Information about the certificate's team and how to edit it

value

string | null

The value of the team element. This should be a team identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

authorized

array of string | null

The list of authorized teams

editable

boolean | null

Whether the team element is editable by the requester

mandatory

boolean | null

Whether the team element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the team element

metadata

array of objects | null (Certificate Metadata)

The technical metadata for this certificate

Array [

metadata

string required

Technical metadata related to the certificate

Enum pki_connector previous_certificate_id renewed_certificate_id automation_policy gs_order_id metapki_id digicert_id entrust_id scep_transid fcms_id gsatlas_id certeurope_id digicert_order_id

value

string | null

The value of the metadata element

editable

boolean | null

Whether the metadata element is editable by the requester

]

capabilities

object | null (Managed Certificate profile crypto policy)

Describes how certificates will be enrolled on this profile

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

keyAvailability

string | null (FiniteDuration)

Availability of the key in the requests (enroll, recover), as well as time during which a non-escrowed key is available for trigger retries

passwordPolicy

object | null (Password Policy)

The password policy that will be used to generate the certificate's PKCS#12 password

name

string required

The name of the password policy

minChar

integer required

The minimum number of characters of the password

maxChar

integer | null

The maximum number of characters of the password

minUpChar

integer | null

The minimum number of uppercase characters of the password

minLoChar

integer | null

The minimum number of lowercase characters of the password

minDiChar

integer | null

The minimum number of digits of the password

spChar

string | null

The special characters of the password accepted by the password policy

minSpChar

integer | null

The minimum number of special characters of the password

autoRenew

object (Certificate Auto Renew)

Auto renewal template information

value

boolean required

Value to set the auto renew property to

editable

boolean required

Whether the auto renew property is editable or not on this certificate

termsOfService

string

If the query parameter termsOfService was set to true, and the profile contains Terms Of Service, contains the contents of the terms of service

workflow

string required

The request workflow

Value update

module

string (Module) required

The module of the certificate to update.

Enum webra est scep acme crmp acme-external intune jamf intunepkcs

profile

string (Certificate profile) required

The profile for which to return the template.

template

object (WebRA Update Request Template) required

The template with the constraint set on the profile

labels

array of objects | null (Label)

Information about the certificate's labels and how to edit them

Array [

label

string required

The name of the label

displayName

array of objects | null (LocalizedString)

The display name of the label element

description

array of objects | null (LocalizedString)

The description of the label element

value

string | null

The 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 this request

editable

boolean | null

Whether the label element is editable

regex

string | null

The regex used to validate the label element

enum

array of string | null

The enum used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

metadata

array of objects | null (Certificate Metadata)

Information about the certificate's metadata and how to edit them

Array [

metadata

string required

Technical metadata related to the certificate

value

string | null

The value of the metadata element

editable

boolean | null

Whether the metadata element is editable by the requester

]

owner

object | null (Certificate Owner)

Information about the certificate's owner and how to edit it

value

string | null

The value of the owner element. This should be a principal identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the owner element is editable by the requester

mandatory

boolean | null

Whether the owner element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the owner element

team

object | null (Certificate Team)

Information about the certificate's team and how to edit it

value

string | null

The value of the team element. This should be a team identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

authorized

array of string | null

The list of authorized teams

editable

boolean | null

Whether the team element is editable by the requester

mandatory

boolean | null

Whether the team element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the team element

contactEmail

object | null (Contact email)

Information about the certificate's contact email and how to edit it

value

string | null

The contact email

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the contact email is editable by the requester

mandatory

boolean | null

Whether the contact email is mandatory to submit this request

regex

string | null

The regular expression to validate the contact email

whitelist

array of string | null

The list of allowed contact emails

description

array of objects | null (LocalizedString)

The description of the contact email

autoRenew

object (Certificate Auto Renew)

Auto renewal template information

value

boolean required

Value to set the auto renew property to

editable

boolean required

Whether the auto renew property is editable or not on this certificate

workflow

string required

The request workflow

Value migrate

module

string (Module) required

The module for which to return the template.

Enum webra est scep acme crmp acme-external intune jamf intunepkcs

profile

string (Certificate profile) required

The profile for which to return the template.

template

object (WebRA Migrate Request Template) required

The template with the constraint set on the profile

labels

array of objects | null (Label)

Array [

label

string required

The name of the label

displayName

array of objects | null (LocalizedString)

The display name of the label element

description

array of objects | null (LocalizedString)

The description of the label element

value

string | null

The 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 this request

editable

boolean | null

Whether the label element is editable

regex

string | null

The regex used to validate the label element

enum

array of string | null

The enum used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

owner

object | null (Certificate Owner)

value

string | null

The value of the owner element. This should be a principal identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the owner element is editable by the requester

mandatory

boolean | null

Whether the owner element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the owner element

team

object | null (Certificate Team)

value

string | null

The value of the team element. This should be a team identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

authorized

array of string | null

The list of authorized teams

editable

boolean | null

Whether the team element is editable by the requester

mandatory

boolean | null

Whether the team element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the team element

metadata

array of objects | null (Certificate Metadata)

Array [

metadata

string required

Technical metadata related to the certificate

value

string | null

The value of the metadata element

editable

boolean | null

Whether the metadata element is editable by the requester

]

contactEmail

object | null (Contact email)

value

string | null

The contact email

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the contact email is editable by the requester

mandatory

boolean | null

Whether the contact email is mandatory to submit this request

regex

string | null

The regular expression to validate the contact email

whitelist

array of string | null

The list of allowed contact emails

description

array of objects | null (LocalizedString)

The description of the contact email

autoRenew

object (Certificate Auto Renew)

Auto renewal template information

value

boolean required

Value to set the auto renew property to

editable

boolean required

Whether the auto renew property is editable or not on this certificate

workflow

string required

The request workflow

Value renew

profile

string required

The profile on which the renewal occurred

module

string required

The module for which to return the template.

Value webra

template

object (WebRA Renew Request Template) required

The cryptography policy applied during the renewal of a certificate

capabilities

object | null (Managed Certificate profile crypto policy)

Describes how certificates will be enrolled on this profile

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

keyAvailability

string | null (FiniteDuration)

Availability of the key in the requests (enroll, recover), as well as time during which a non-escrowed key is available for trigger retries

passwordPolicy

object | null (Password Policy)

The password policy that will be used to generate the certificate's PKCS#12 password

name

string required

The name of the password policy

minChar

integer required

The minimum number of characters of the password

maxChar

integer | null

The maximum number of characters of the password

minUpChar

integer | null

The minimum number of uppercase characters of the password

minLoChar

integer | null

The minimum number of lowercase characters of the password

minDiChar

integer | null

The minimum number of digits of the password

spChar

string | null

The special characters of the password accepted by the password policy

minSpChar

integer | null

The minimum number of special characters of the password

autoRenew

object (Certificate Auto Renew)

Auto renewal template information

value

boolean required

Value to set the auto renew property to

editable

boolean required

Whether the auto renew property is editable or not on this certificate

workflow

string required

The request workflow

Value import

module

string required

The module for which to return the template.

profile

string (Certificate profile) required

The profile for which to return the template.

template

object (WebRA Import Request Template) required

The template with the constraint set on the profile

owner

object | null (Certificate Owner)

The owner for this certificate

value

string | null

The value of the owner element. This should be a principal identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the owner element is editable by the requester

mandatory

boolean | null

Whether the owner element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the owner element

team

object | null (Certificate Team)

The team for this certificate

value

string | null

The value of the team element. This should be a team identifier

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

authorized

array of string | null

The list of authorized teams

editable

boolean | null

Whether the team element is editable by the requester

mandatory

boolean | null

Whether the team element is mandatory to submit this request

description

array of objects | null (LocalizedString)

The description of the team element

contactEmail

object | null (Contact email)

The contact email for this certificate

value

string | null

The contact email

computationRule

string | null (Computation Rule)

Computation rule input will be evaluated and will override all other inputs

editable

boolean | null

Whether the contact email is editable by the requester

mandatory

boolean | null

Whether the contact email is mandatory to submit this request

regex

string | null

The regular expression to validate the contact email

whitelist

array of string | null

The list of allowed contact emails

description

array of objects | null (LocalizedString)

The description of the contact email

labels

array of objects | null (Label)

The labels for this certificate

Array [

label

string required

The name of the label

displayName

array of objects | null (LocalizedString)

The display name of the label element

description

array of objects | null (LocalizedString)

The description of the label element

value

string | null

The 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 this request

editable

boolean | null

Whether the label element is editable

regex

string | null

The regex used to validate the label element

enum

array of string | null

The enum used to validate the label element

suggestions

array of string | null

The suggestions used to recommend the label element values

]

metadata

array of objects | null (Certificate Metadata)

The technical metadata for this certificate

Array [

metadata

string required

Technical metadata related to the certificate

value

string | null

The value of the metadata element

editable

boolean | null

Whether the metadata element is editable by the requester

]

thirdPartyData

array of objects | null (ThirdPartyItem)

The third party data associated with the certificate

Array [

connector

string required

The third party connector name on which this certificate is synchronized

string required

The Id of this certificate on the third party

fingerprint

string | null

The fingerprint of this certificate on the third party

pushDate

integer | null

The date when the certificate was pushed to this third party

removeDate

integer | null

The date when the certificate was removed from this third party (in case of revocation)

]

discoveryInfo

object | null (DiscoveryInfo)

Information about the discovery of this certificate

campaign

string required

The discovery campaign's name

lastDiscoveryDate

integer required

When this certificate was discovered for the last time

identifier

string | null

Identifier of the user that discovered this certificate

discoveryData

object (HostDiscoveryData)

The host discovery data associated with the certificate (discovery metadata)

string | null

The certificate's host ip

sources

array of string | null

Information on the type of discovery that discovered this certificate

hostnames

array of string | null

The certificate's host hostnames (netscan only)

operatingSystems

array of string | null

The certificate's host operating system (localscan only)

paths

array of string | null

The path to the certificate on the host machine (localscan only)

usages

array of string | null

The path of the configuration files that were used to find the certificates

tlsPorts

array of objects | null (TlsPort)

The ports on which the certificate is exposed for https connexion

autoRenew

object (Certificate Auto Renew)

Auto renewal template information

value

boolean required

Value to set the auto renew property to

editable

boolean required

Whether the auto renew property is editable or not on this certificate

workflow

string required

The workflow for which to return the template.

Value enroll

module

string required

The request module

Value est

template

object (EST Enroll Request Template) required

The template with the constraint set on the profile

dnWhitelist

boolean | null

DN whitelist is enabled on this request

termsOfService

string

If the query parameter termsOfService was set to true, and the profile contains Terms Of Service, contains the contents of the terms of service

subject

array of objects | null (IndexedDNElement)

List of DN elements that will be used to build the certificate's Distinguished Name

Array [

element

string required

value

string | null

The element value

]

sans

array of objects | null (SAN Element)

List of SAN elements that will be used to build the certificate's Subject Alternative Name

Array [

type

string | null required

SAN type

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

value

array of string | null

SAN value

]

extensions

array of objects | null (Certificate Extension)

Information about the certificate's extensions and how to edit them

Array [

type

string required

The type of the extension element

Enum ms_sid ms_template ms_template_v2

value

string | null

The value of the extension element

]

labels

array of objects | null (Label)

List of labels used internally to tag and group certificates

Array [

label

string required

The name of the label

value

string | null

The value of the label element

]

contactEmail

object | null (Contact email)

Information about the certificate's contact email and how to edit it

value

string | null

The contact email

owner

object | null (Certificate Owner)

Information about the certificate's owner and how to edit it

value

string | null

The value of the owner element. This should be a principal identifier

team

object | null (Certificate Team)

Information about the certificate's team and how to edit it

value

string | null

The value of the team element. This should be a team identifier

profile

string (Certificate profile) required

The profile for which to return the template.

workflow

string required

The workflow for which to return the template.

Value enroll

module

string required

The request module

Enum scep jamf

template

object (SCEP Enroll Request Template) required

The template with the constraint set on the profile

dnWhitelist

boolean | null

DN whitelist is enabled on this request

termsOfService

string

If the query parameter termsOfService was set to true, and the profile contains Terms Of Service, contains the contents of the terms of service

subject

array of objects | null (IndexedDNElement)

List of DN elements that will be used to build the certificate's Distinguished Name

Array [

element

string required

value

string | null

The element value

]

sans

array of objects | null (SAN Element)

List of SAN elements that will be used to build the certificate's Subject Alternative Name

Array [

type

string | null required

SAN type

Enum RFC822NAME DNSNAME URI IPADDRESS OTHERNAME_UPN OTHERNAME_GUID REGISTERED_ID

value

array of string | null

SAN value

]

extensions

array of objects | null (Certificate Extension)

Information about the certificate's extensions and how to edit them

Array [

type

string required

The type of the extension element

Enum ms_sid ms_template ms_template_v2

value

string | null

The value of the extension element

]

labels

array of objects | null (Label)

List of labels used internally to tag and group certificates

Array [

label

string required

The name of the label

value

string | null

The value of the label element

]

contactEmail

object | null (Contact email)

Information about the certificate's contact email and how to edit it

value

string | null

The contact email

owner

object | null (Certificate Owner)

Information about the certificate's owner and how to edit it

value

string | null

The value of the owner element. This should be a principal identifier

team

object | null (Certificate Team)

Information about the certificate's team and how to edit it

value

string | null

The value of the team element. This should be a team identifier

profile

string (Certificate profile) required

The profile for which to return the template.

400 Invalid request

401 Unauthorized request

403 Forbidden action

404 No profile specified

500 Internal server error

post

/api/v1/requests/template

{

"workflow": "enroll" ,

"module": "webra" ,

"profile": "webra_centralized" ,

"template":

{ ... } ,

"certificateId": "6448d56b310000400063f014" ,

"certificatePem": "-----BEGIN CERTIFICATE----- ..."

}