メタデータ API 開発者ガイド
jCertificate
要求がユーザの組織からのものであることを検証するデジタル署名に使用される証明書を表します。証明書は、外部 Web サイトとの認証済みシングルサインオンで使用されるか、組織を ID プロバイダとして使用するときに使用されます。MetadataWithContent メタデータ型を拡張し、その content 項目と fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
Certificate コンポーネントのサフィックスは .crt で、certs フォルダに保存されます。
バージョン
Certificate コンポーネントは、API バージョン 36.0 以降で使用できます。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| caSigned | boolean | 必須。この証明書が発行者によって署名されているか (true)、否か (false) を示します。 |
| encryptedWithPlatformEncryption | boolean | プラットフォームの暗号化を使用して、この証明書が暗号化されているかどうかを示します。 |
| expirationDate | dateTime | この証明書の有効期限が切れ、使用できなくなる日付。自己署名証明書では、keySize が 2048 ビットの場合、自動的に有効期限は証明書作成から 1 年後になります。keySize が 4096 ビットの場合、自動的に有効期限は証明書作成から 2 年後になります。CA 署名証明書では、署名証明書チェーンがアップロードされると、expirationDate は自動的に署名証明書の有効期限に更新されます。日付形式は YYYY-MM-DD です。 |
| keySize | int | 証明書の鍵は 2048 ビットまたは 4096 ビットです。2048 ビット鍵を持つ証明書は 1 年、4096 ビット鍵を持つ証明書は 2 年間有効です。2048 ビット鍵を持つ証明書は、4096 ビット鍵を持つ証明書よりも有効期限が短くなります。keySize を指定しないと、証明書を作成するときに鍵のサイズがデフォルトの 2048 ビットに設定されます。 |
| masterLabel | string | 必須。[証明書と鍵の管理] などの Salesforce ユーザインターフェースに表示される、証明書のわかりやすい名前。最大 64 文字です。 |
| privateKeyExportable | boolean | この証明書の非公開鍵がエクスポート可能かどうかを示します。証明書を作成するときに privateKeyExportable を指定しないと、デフォルト値が true になります。 |
使用方法
メタデータ API を使用して、自己署名証明書または CA 署名証明書を作成できます。.crt ファイルの内容は証明書チェーンです。これは、CA 署名証明書の中間証明書チェーンを更新するときに更新できます。CA 署名証明書を作成すると、.crt ファイルに証明書署名要求 (CSR) が含まれます。詳細は、Salesforce ヘルプの「Salesforce 証明書と鍵について」を参照してください。
既存の証明書の X.509 パラメータデータを新しい証明書にコピーするには、既存の証明書をアップロードします。次の手順でも証明書を更新することができます。新しい証明書を使用して、新しい非公開鍵と公開鍵のペアが作成されます。Salesforce では、API を介した非公開鍵のインポートまたはエクスポートは許可されていません。
メタデータ API を使用して、CSR をダウンロードできます。認証機関で署名されたら、Salesforce にアップロードできます。
- CSR のダウンロード。CSR は、CA 署名証明書の作成後にダウンロードできます。署名済み証明書がその証明書にアップロードされていない場合、ダウンロードした .crt ファイルの内容は CSR です。
- CA 署名証明書のアップロード。署名済み証明書チェーンを Salesforce にアップロードするには、署名済み証明書チェーンを .crt ファイルの内容として保存し、メタデータ API で更新します。
宣言的なメタデータの定義のサンプル
Certificate コンポーネントの例を次に示します。
1<?xml version="1.0" encoding="UTF-8"?>
2<Certificate xmlns="http://soap.sforce.com/2006/04/metadata">
3 <caSigned>true</caSigned>
4 <encryptedWithPlatformEncryption>true</encryptedWithPlatformEncryption>
5 <expirationDate>2017-03-19</expirationDate>
6 <keySize>4096</keySize>
7 <masterLabel>My Certificate Name</masterLabel>
8 <privateKeyExportable>true</privateKeyExportable>
9</Certificate>マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。