MobSecurityCertPinConfig | Metadata API Developer Guide

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

Parent Type

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

File Suffix and Directory Location

MobSecurityCertPinConfig components have the suffix .mobSecurityCertPinConfig and are stored in the mobSecurityCertPinConfigs folder.

Version

MobSecurityCertPinConfig components are available in API version 53.0 and later.

Special Access Rules

The Enhanced Mobile App Security add-on subscription and the Enforce Enhanced Mobile App Security user permission are required to use this metadata type.

Fields

Field Name	Description
certificateHash	Field Type string Description Required. The unique identifier for the certificate.
domainName	Field Type string Description Required. The name of the domain for the server that you want to pin the certificate to. For example, `https://MyDomainName.my.salesforce.com`.
isEnabled	Field Type boolean Description Required. Indicates whether authentication server certificate pinning is enabled. The default value is `false`, which means that certificate pinning is disabled.
isProtected	Field Type boolean Description An auto-generated value that doesn’t impact the behavior of the metadata type. The default value is `false`.
isSubdomainIncluded	Field Type boolean Description Required. Indicates whether subdomains use the same certificate pinning configuration as the specified domainName. The default value is `false`.
masterLabel	Field Type string Description Required. A user-friendly name for MobSecurityCertPinConfig, which is defined when the MobSecurityCertPinConfig component is created.
mobilePlatform	Field Type MobileSecurityMobilePlatform (enumeration of type string) Description The mobile operating system. Values are: `Android` `iOS`
mobileSecurityAssignment	Field Type string Description The name of the mobile security assignment associated with the mobile security policy. See MobileSecurityAssignment.
severityLevel	Field Type MobileSecurityPolicySeverityLevel (enumeration of type string) Description Required. The severity level of the mobile security policy. Values are: `Critical`— Wipes app data and logs user out `Error`—Blocks access to the app until the issue is resolved, but doesn’t log user out `Info`— Blocks prohibited action or logs user action and informs user `Warn`—Notifies the user of the violation and recommends how to resolve, but user is able to continue using the app
type	Field Type MobileSecurityCertPinType (enumeration of type string) Description Required. The type of pin. Values are: `AuthServer` `Resource`

Declarative Metadata Sample Definition

The following is an example of a MobSecurityCertPinConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<MobileSecurityCertPinConfig xmlns="http://soap.sforce.com/2006/04/metadata">
3    <certificateHash>AaBbCcDdEeFfGg</certificateHash>
4    <domainName>login.salesforce.com</domainName>
5    <isEnabled>true</isEnabled>
6    <isProtected>false</isProtected>
7    <masterLabel>AuthenticationServerCertificatePinning</masterLabel>
8    <mobilePlatform>Android</mobilePlatform>
9    <mobileSecurityAssignment>MyMobileSecurityAssignment</mobileSecurityAssignment>
10    <severityLevel>info</severityLevel>
11    <type>AuthServer</type>
12</MobileSecurityCertPinConfig>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>MobileSecurityCertPinConfig</name>
6    </types>
7    <version>61.0</version>
8</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.