Newer Version Available

This content describes an older version of this product. View Latest

Certificate

Represents a certificate used for digital signatures which verify that requests are coming from your org. Certificates are used for either authenticated single sign-on with an external website, or when using your org as an identity provider. This metadata type extends the MetadataWithContent component and shares its fields.

File Suffix and Directory Location

Certificate components have the suffix .certificate and are stored in the certificate folder.

Version

Certificate components are available in API version 36.0 and later.

Fields

Field Name Field Type Description
caSigned boolean Required. Indicates whether this certificate is signed by the issuer (true) or not (false).
keySize int Required. Certificate keys can be either 2048 bits or 4096 bits. A certificate with 4096-bit keys lasts two years, and a certificate with 2048-bit keys lasts one year. Certificates with 2048-bit keys are faster than certificates with 4096-bit keys.
masterLabel string Required. A user-friendly name for the certificate that appears in the Salesforce user interface, such as in Certificate and Key Management. Limit: 64 characters.

Declarative Metadata Sample Definition

The following is an example of a Certificate component.