証明書要求生成オプションを取得する

クライアント側の証明書要求の生成のためのパラメーターを取得します。

Note

この記事の URL は、API のデプロイ中に選択されたホスト名 (例: ) を基準にしています https://api.contoso.com

Request

Method 要求 URL
GET /CertificateManagement/api/v1.0/requests/{requestid}/certificaterequestgenerationoptions

URL パラメーター

パラメーター 説明
requestid 必須。 証明書の要求生成パラメーターを取得するための MIM CM 要求の GUID 識別子。

要求ヘッダー

一般的な要求ヘッダーについては、CM の HTTP 要求ヘッダーと応答ヘッダーに関するページREST APIを参照してください

要求本文

[なし] :

Response

このセクションでは、応答について説明します。

応答コード

コード 説明
200 [OK]
204 コンテンツなし
403 Forbidden
500 内部エラー

応答ヘッダー

一般的な要求ヘッダーについては、CM の HTTP 要求ヘッダーと応答ヘッダーに関するページREST APIを参照してください

応答本文

成功すると、CertificateRequestGenerationOptions オブジェクトの一覧が返されます。 各 CertificateRequestGenerationOptions オブジェクトは、クライアントが生成する必要がある 1 つの証明書要求に対応します。 各オブジェクトには、次のプロパティがあります。

プロパティ 説明
Exportable 要求用に作成された秘密キーがエクスポート可能かどうかを指定する値。
FriendlyName 登録済み証明書の表示名。
HashAlgorithmName 証明書要求の署名を作成する際に使用されるハッシュ アルゴリズム。
KeyAlgorithmName 公開キーのアルゴリズム。
KeyProtectionLevel 強力なキーの保護レベル。
KeySize 生成される秘密キーのサイズ (ビット)。
KeyStorageProviderNames 秘密キーを生成するために使用可能なキー格納プロバイダー (KSP) の一覧。 最初の KSP を使用して証明書要求を生成できない場合、指定された KSP は成功するまで使用できます。
KeyUsages この証明書の要求のために作成された秘密キーで実行可能な操作。 既定値は Signing です。
サブジェクト サブジェクト名。

Note

これらのプロパティの詳細については、次のWindows。Security.Cryptography.Certificates.CertificateRequestProperties クラスの説明。 このクラスと CertificateRequestGenerationOptions オブジェクトの間には 1 対 1 の対応は使用されないので、ご安心ください。

このセクションでは、証明書要求の生成オプションを取得する例を示します。

例: 要求

GET /certificatemanagement/api/v1.0/requests/a9b4b42c-cc50-4c9b-89d1-bbc0bcd5a099/certificaterequestgenerationoptions HTTP/1.1

例: 応答

HTTP/1.1 200 OK

[
    {
        "Subject":"",
        "KeyAlgorithmName":"RSA",
        "KeySize":2048,
        "FriendlyName":"",
        "HashAlgorithmName":"SHA1",
        "KeyStorageProviderNames":[
            "Contoso Smart Card Key Storage Provider"
        ],
        "Exportable":0,
        "KeyProtectionLevel":0,
        "KeyUsages":3
    }
]