X509 Certificate Store API

Predominant token scope: Restricted

The X509 Certificate Store is a wrapper around Secret Store. It provides specific datatypes for certificates, and automatically handles the creation of associations for common certificate values. The X509 Certificate Store uses the following encodings and data structures:

• CertificateString
• CertificateCollectionStrings
• TypedNameValues

Example 1: Encoding with CertificateString

A certificate string is the raw DER data of a certificate, encoded in Base64. The following is the JSON format:

{
   "CertificateString":"MIIF5DCCBMygTo/ILxbX"
}

Example 2: Encoding with CertificateCollectionStrings

An array of strings, representing Base64‑encoded DER certificates. The following CertificateCollectionStrings are in the JSON format:

{
   "CertificateCollectionStrings":[
      "MIIE9jCCA96gAwIBAgIQAq+AriUucEonoNomjLiAu3dSQchDTLjfPrdSkHag=",
      "MIIEnDCCBAWgAwIBAgIQdTNoszcYz0KyNCFkR9MgazpM3OYDkAw=",
      "MIICPDCCAaUCEHC65B0Q2SyAw7xzvjoyVGM5mKf5p/AfbdynMk2OmufTqj/ZA1k"
   ]
}

Example 3: Encoding with TypedNameValues

An array of Name/Type/Value triplets. The following TypedNameValues are in the JSON format:

{
   "TypedNameValues":[
      {
         "Name":"X509CertificateStoreTest",
         "Type":"int",
         "Value":"1"
      },
      {
         "Name":"Storeme",
         "Type":"string",
         "Value":"iamastring"
      },
      {
         "Name":"Yodel",
         "Type":"datetime",
         "Value":"1998202329"
      }
   ]
}

Result

A number indicating indicating success 0 or failure. Because all X509 endpoints are wrappers for Secret Store, see SecretStore result codes.