GetData: Certificate types

This page documents the data types available in GetData for certificates, certificate authorities, and certificate templates.

\{internal.certificate.%%}

\{internal.certificate.%%}

This will return attributes and types from a certificate in the system. An identifier of the certificate is required for loading these data.

\{internal.certificate.id}

Returns the unique id of the certificate.

\{internal.certificate.name}

Returns the name (common name of the subject extension) of the certificate.

\{internal.certificate.organizationid}

Returns the organization id of the certificate.

\{internal.certificate.refereceid}

Returns the id of the owner of the certificate. The unique id of the user or end entity.

\{internal.certificate.manufacturerid}

Returns the id of the certificate manufacturer which is the same as a certificate authority.

\{internal.certificate.templateid}

Returns the id of current certificate template.

\{internal.certificate.notificationlevel}

Returns the current level of notification. See TimerService.Module.Monitor.NotifyExpiredCertificates section for more information.

\{internal.certificate.authoritykeyid}

Returns the authority key id of the certificate.

\{internal.certificate.subject}

Returns the subject of the certificate.

\{internal.certificate.subjectalternativename}

Returns the subject alternative name attributes of the certificate.

\{internal.certificate.serialnumber}

Returns the serial number of the certificate. Do not confuse this attribute with the serial number in the subject.

\{internal.certificate.thumbprint}

Returns the thumbprint (hash/digest) of the certificate.

\{internal.certificate.issuer}

Returns the issuer of the certificate.

\{internal.certificate.keyusage}

Returns the key usage of the certificate (e.g. 0xA0, 0x40 etc.).

\{internal.certificate.manufacturertemplatename}

Returns the template name of the certificate authority if available.

\{internal.certificate.validfrom}

Returns the validity when the certificate was issued.

\{internal.certificate.validto}

Returns the validity when the certificate will be expired.

\{internal.certificate.revocationdatetime}

Returns the date and time when the certificate was revoked.

\{internal.certificate.revocationuser}

Return the name of the user that processed the revocation of the certificate.

\{internal.certificate.data}

Returns the certificate as base64-encoded string.

\{internal.certificate.keydata}

Returns the certificate as PKCS#12 base64-encoded string if available. Note that the key data only can be accessed if the certificate has a relation to the current user. It’s not possible to access key data of other users.

\{internal.certificate.keypassword}

Returns the key data protection password if available. Note that the key password only can be accessed if the certificate has a relation to the current user. It’s not possible to access key password of other users.

\{internal.certificate.referencetype}

Returns the reference type of the certificate. Available types are: Undefined, External, ManufacturerDatabase, User and EndEntity.

\{internal.certificate.referencetypeid}

Returns the reference type id of the certificate. Available types are: 0, 1, 2, 10 and 20.

\{internal.certificate.status}

Returns the status of the certificate. Available types are: Unknown, Valid, Expired, Revoked and NotApproved.

\{internal.certificate.statusid}

Returns the status id of the certificate. Available types are: 0, 1, 2, 3 and 4.

\{internal.certificate.statusreason}

Returns the status reason of the certificate. Available types are, NotRevoked, Unspecified, KeyCompromise, CACompromise, AffiliationChanged, Superseded, CessationOfOperation, CertificateHold, PrivilegeWithdrawn and AaCompromise.

\{internal.certificate.statusreasonid}

Returns the status reason of the certificate. Available types are, -1, 0, 1, 2, 3, 4, 5, 6, 9 and 10.

\{internal.certificate.issuancetype}

Returns the type of issuance how the certificate was enrolled. Available types are: Undefined, UseExistingKey and GenerateNewKey.

\{internal.certificate.issuancetypeid}

Returns the type of issuance id how the certificate was enrolled. Available types are: 0, 1 and 2.

\{internal.certificate.enrollmenttype}

Returns the type of enrollment. Available types are: Undefined, FromRequest, FromTemplate and FromInput.

\{internal.certificate.enrollmenttypeid}

Returns the type of enrollment id. Available types are: 0, 1, 2 and 3.

\{internal.certificate.extrainfo}

Returns extra customized information of the certificate if available.

\{internal.certificate.additionalinfo}

Returns additional information of the certificate if available.

\{internal.certificate.hashalgorithm}

Returns the hash algorithm of the certificate (e.g. SHA256).

\{internal.certificate.signaturealgorithm}

Returns the signature algorithm of the certificate (e.g. SHA256RSA).

\{internal.certificate.publickeyalgorithm}

Returns the algorithm name of the public key (e.g. RSA).

\{internal.certificate.hastokenrelation}

Returns condition (true/false) if the certificate has related token.

\{internal.certificate.tokenid}

Returns the id of the related token if exists.

\{internal.certificateauthority.%%}

\{internal.certificateauthority.%%}

This will return attributes and types from a certificate authority in the system. An identifier of the certificate authority is required for loading these data.

\{internal.certificateauthority.id}

Returns the unique id of the certificate authority.

\{internal.certificateauthority.organizationid}

Returns the organization id of the certificate authority.

\{internal.certificateauthority.name}

Returns the name of the certificate authority.

\{internal.certificateauthority.description}

Returns description if available.

\{internal.certificateauthority.server}

Returns the server to the service.

\{internal.certificateauthority.certauthhash}

Returns the thumbprint (hash/digest) of the authentication certificate for certificate authority web services.

\{internal.certificateauthority.certsignhash}

Returns the thumbprint (hash/digest) of the signature certificate of the certificate authority if available.

\{internal.certificateauthority.type}

Returns the type name of certificate authority. Available types are MSCA and EJBCA and InternalCA.

\{internal.certificateauthority.enrollmenttype}

Returns the type name of enrollment structure. Available types are AgentSigner, Modifier and Stamp.

\{internal.certificateauthority.crllist}

Returns the configured CRL list.

\{internal.certificateauthority.ocsplist}

Returns the configured OCSP list.

\{internal.certificateauthority.authoritykeyid}

Returns the authority key id of the certificate authority.

\{internal.certificateauthority.certificate}

Returns the CA-certificate as base64-encoded string.

\{internal.certificateauthority.isenabled}

Returns true/false if the certificate is enabled or not.

\{internal.certificateauthority.allowlogin}

Returns true/false if the certificate authority allows login into the system.

\{internal.certificateauthority.additionalinfo}

Returns additional information of the certificate authority if available.

\{internal.certificateauthority.ping}

Returns true/false if the certificate authority service has communication available.

\{internal.certificatetemplate.%%}

\{internal.certificatetemplate.%%}

This will return attributes and types from a certificate template in the system. An identifier of the certificate template is required for loading these data.

\{internal.certificatetemplate.id}

Returns the unique id of the certificate template.

\{internal.certificatetemplate.organizationid}

Returns the organization id of the certificate template.

\{internal.certificatetemplate.manufacturerid}

Returns the id of the certificate manufacturer which is the same as a certificate authority.

\{internal.certificatetemplate.name}

Returns the name of the certificate template.

\{internal.certificatetemplate.description}

Returns description if available.

\{internal.certificatetemplate.manufacturertemplatename}

Returns the name of template of the certificate authority service if available.

\{internal.certificatetemplate.manufacturerprofilename}

Returns the name of profile of the certificate authority service if available.

\{internal.certificatetemplate.manufacturerentityname}

Returns the name of the entity of the certificate authority service if available.

\{internal.certificatetemplate.validitykey}

Returns the identifier of the validity key as a numeric value.

\{internal.certificatetemplate.validityvalue}

Returns the value of the validity as a numeric value.

\{internal.certificatetemplate.referencetype}

Returns the reference type of the certificate. Available types are: Undefined, External, ManufacturerDatabase, User and EndEntity.

\{internal.certificatetemplate.userecover}

Returns true/false if the certificate should support recover. This will make the application to generate the key pair instead of a secured hardware token.

\{internal.certificatetemplate.isvisible}

Returns true/false if the certificate template should be visible in generic lists.

\{internal.certificatetemplate.additionalinfo}

Returns additional information of the certificate template if available.