Retrieve a request template :: EVERTRUST documentation

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

capabilities

object | null (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

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

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

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

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

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

]

workflow

string required

The request workflow

Value revoke

module

string (Module) required

The module on which the certificate will be revoked.

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 Revoke Request Template) required

The reason for revoking the certificate

revocationReason

string | null (Revocation Reason)

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

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

value

string | null

The value of the label element

]

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

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

]

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

contactEmail

object | null (Contact email)

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

value

string | null

The contact email

workflow

string required

The request workflow

Value recover

module

string (Module) required

The module of the profile.

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

template

object (WebRA Recover Request Template) required

The cryptography policy applied during the recovery of a certificate

passwordMode

string | null

The password mode of the certificate

Enum random manual

passwordPolicy

object | null (Password Policy)

The selected password policy for this profile. If none is defined and the password mode is manual, there is no constraint on the password. In random mode, the Horizon-Default policy is used

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

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

value

string | null

The value of the label element

]

owner

object | null (Certificate Owner)

value

string | null

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

team

object | null (Certificate Team)

value

string | null

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

metadata

array of objects | null (Certificate Metadata)

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

]

contactEmail

object | null (Contact email)

value

string | null

The contact email

workflow

string required

The request workflow

Value renew

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 (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

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

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

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

contactEmail

object | null (Contact email)

The contact email for this certificate

value

string | null

The contact email

labels

array of objects | null (Label)

The labels for this certificate

Array [

label

string required

The name of the label

value

string | null

The value of the label 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

]

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

id

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)

ip

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

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

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

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

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

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

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

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.