Certificate

Represents a certificate used for digital signatures that verify 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.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Version 

Introduced in API version 37.0.

Supported SOAP API Calls 

describeSObjects(), query(), retrieve()

Supported REST API Methods 

GET, HEAD, Query

Fields 

CertificateChain 

• Type: base64
• Required: No
• Properties: Filter, Group, Nillable, Sort

DeveloperName 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.

  When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, Salesforce generates one for each record, which slows performance.

  Note

ExpirationDate 

• Type: datetime

• Required: No

• Properties: Filter, Nillable, Sort

• Description: Read only. The date that this certificate expires and is no longer usable. For self-signed certificates, if KeySize is 2048 bits, the expiration date is automatically 1 year after you create the certificate. If KeySize is 4096 bits, the expiration date is automatically 2 years after you create the certificate. For CA-signed certificates, ExpirationDate is automatically updated to the signed certificate’s expiration date when a signed certificate chain is uploaded. The date format is YYYY-MM-DD.

KeySize 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Certificate keys can be either 2048 bits or 4096 bits. A certificate with 4096-bit keys lasts 2 years, and a certificate with 2048-bit keys lasts 1 year. Certificates with 2048-bit keys are faster than certificates with 4096-bit keys. If KeySize isn’t specified when you create a certificate, the key size defaults to 2048 bits.

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: 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.

OptionsIsArchiveByok 

• Type: boolean
• Required: No
• Properties: Filter

OptionsIsAwsByok 

• Type: boolean
• Required: No
• Properties: Filter

OptionsIsBnRByok 

• Type: boolean
• Required: No
• Properties: Filter

OptionsIsCaSigned 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Required. Indicates whether this certificate is signed by the issuer (true) or not (false).

OptionsIsDCByok 

• Type: boolean
• Required: No
• Properties: Filter

OptionsIsEncryptedWithPE 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Indicates whether this certificate is encrypted with Shield Platform Encryption.

OptionsIsKeyExportTle 

• Type: boolean
• Required: No
• Properties: Filter

OptionsIsNewEncr 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Indicates whether this certificate is encrypted with the new algorithm for certificate encryption.

OptionsIsPrivateKeyExportable 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Indicates whether this certificate’s private key is exportable.

OptionsIsSystemManaged 

• Type: boolean
• Required: No
• Properties: Filter

OptionsIsUnusable 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Indicates whether this certificate is waiting for import of the signed certificate chain.

OptionsIsUsingKMS 

• Type: boolean
• Required: No
• Properties: Filter