取得憑證要求產生選項

取得用於產生用戶端憑證要求的參數。

注意

本文中的 Url 會相對於 API 部署期間所選擇的主機名稱,例如 https://api.contoso.com

要求

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

URL 參數

參數 描述
requestid 必要。 MIM CM 的 GUID 識別碼,表示依該要求擷取憑證要求產生參數。

要求標頭

關於常見的要求標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭

要求本文

無。

回應

本節說明回應。

回應碼

程式碼 描述
200 [確定]
204 沒有內容
403 禁止
500 內部錯誤

回應標頭

關於常見的要求標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭

回應本文

成功時,會傳回 CertificateRequestGenerationOptions 物件的清單。 每個 CertificateRequestGenerationOptions 物件都對應至用戶端必須產生的單一憑證要求。 每個物件都具有下列屬性:

屬性 描述
Exportable 此值指定是否可以匯出依要求而建立的私密金鑰。
FriendlyName 註冊憑證的顯示名稱。
HashAlgorithmName 建立憑證要求簽章時使用的雜湊演算法。
KeyAlgorithmName 公開金鑰演算法。
KeyProtectionLevel 增強式金鑰保護層級。
KeySize 要產生的私密金鑰的大小 (位元)。
KeyStorageProviderNames 可接受用來產生私密金鑰的金鑰儲存提供者 (KSP) 清單。 如果無法使用第一個 KSP 來產生憑證要求,則可使用任何指定的 Ksp,直到其中一個都成功為止。
KeyUsages 此憑證要求所建立的私密金鑰可執行的作業。 預設值為 Signing。
主旨 主體名稱。

注意

這些屬性的詳細資訊可在 Windows 中取得。Windows.security.cryptography.certificates.certificaterequestproperties 類別描述。 請記住,這個類別和 CertificateRequestGenerationOptions 物件之間沒有一對一的對應關係。

範例

本節提供取得憑證要求產生選項的範例。

範例:要求

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
    }
]