UserAuthCertificate

Represents a PEM-encoded user certificate. These certificates are associated with a user, and externally uploaded. The uploaded certificate is used to authenticate the user.

This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

UserAuthCertificate components have the suffix .userAuthCertificate and are stored in the userAuthCertificates folder.

Version

UserAuthCertificate components are available in API version 50.0 and later.

Fields

Field Name	Field Type	Description
developerName	string	Required: The name of the certificate with an underscore between words. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
expirationDate	dateTime	Required. The date on which the certificate expires.
masterLabel	string	Required. A user-friendly name that you create for the certificate. Limited to 64 characters.
serialNumber	string	Required. The serial number for the certificate.
user	string	Required: The user’s name.

Declarative Metadata Sample Definition

The following is an example of a UserAuthCertificate component.

1<UserAuthCertificate xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
2    <content xsi:nil="true"/>
3    <developerName>ND_user_cert</developerName>
4    <expirationDate>2030-10-01T08:30:00.000Z</expirationDate>
5    <masterLabel>ND user cert</masterLabel>
6    <serialNumber>1401</serialNumber>
7    <user>005RM000001Zn1E</user>
8</UserAuthCertificate>

The following is an example package.xml that references the previous definition.

1Package xmlns="http://soap.sforce.com/2006/04/metadata">
2    <types>
3        <members>*</members>
4        <name>UserAuthCertificate</name>
5    </types>
6    <version>50.0</version>
7</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide