PublicKeyCertificateSet

Represents a set of public certificate keys. On this entity we store a public certificates or JSON web keys.

This type extends Metadata and inherits its fields.

PublicKeyCertificateSet components have the suffix .PublicKeyCertificateSet and are stored in the PublicKeyCertificateSet folder.

Introduced in API version 62.0.

There are no additional access requirements that are specific to this type.

• Type: string
• Required: No
• Description: A description of the public key certificate set.

• Type: string
• Required: No
• Description: The URL of the HTTPS Server that returns the JWKS.

• Type: string
• Required: No
• Description: The user, organization, or service that issued the JSON web token. This value is case-sensitive.

• Type: string
• Required: Yes
• Description: Required. The label for the public key certificate set.

• Type: PublicKeyCertificateSetKey[]
• Required: No
• Description: A set of public certificate keys associated with the public key certificate set.

• Type: PublicKeyCertificateSetType (enumeration of type string)

• Required: Yes

• Description: Required. Determines how the server’s public key set is retrieved. The keys are represented in JWK format.

  Values are:

• Possible values:

  • JWKS — Used to specify a certificate via the child Type PublicKeyCertificateSetKey.
  • JWKS_URL — Used to specify a certificate via the jwksEndPoint field on this Type.

Represents a set of public certificate keys associated with the public key certificate set.

• Type: string

• Required: Yes

• Description: Required.

  The PublicKeyCertificate we want to reference.

The following is an example of a PublicKeyCertificateSet component.

1<?xml version="1.0" encoding="UTF-8"?>
2<PublicKeyCertificateSet xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>pcks1</masterLabel>
4    <description>This is my description for a PublicKeyCertificateSet</description>
5    <type>JWKS</type>
6    <jwtIssuer>example.com</jwtIssuer>
7    <publicKeyCertificateSetKeys>
8            <publicKeyCertificate>pck1</publicKeyCertificate>
9    </publicKeyCertificateSetKeys>
10</PublicKeyCertificateSet>

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>PublicKeyCertificate</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>PublicKeyCertificateSet</name>
10    </types>
11    <version>62.0</version>
12</Package>

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.