PublicKeyCertificateSet

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

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

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

Version

PublicKeyCertificateSet components are available in API version 62 and later.

Special Access Rules

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

Fields

Field Name Description
description
Field Type
string
Description
A description of the public key certificate set.
jwksEndPoint
Field Type
string
Description
The URL of the HTTPS Server that returns the JWKS.
jwtIssuer
Field Type
string
Description
The user, organization, or service that issued the JSON web token. This value is case-sensitive.
masterLabel
Field Type
string
Description

Required. The label for the public key certificate set.

publicKeyCertificateSetKeys
Field Type
PublicKeyCertificateSetKey[]
Description
A set of public certificate keys associated with the public key certificate set.
type
Field Type
PublicKeyCertificateSetType (enumeration of type string)
Description

Required. Determines how the server's public key set is retrieved. The keys are represented in JWK format.

Values are:

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

PublicKeyCertificateSetKeys

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

Field Name Description
publicKeyCertificate
Field Type
string
Description

Required.

The PublicKeyCertificate we want to reference.

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.