取得工作流程原則
取得指定工作流程的設定檔範本原則。 資料會在要求建立期間使用。 工作流程原則指定用戶端需要哪些資料來建立要求。 資料可以包含各種資料收集專案、要求批註,以及一次性密碼原則。
注意
本文中的 URL 相對於 API 部署期間所選擇的主機名稱,例如 https://api.contoso.com
。
要求
方法 | 要求 URL |
---|---|
GET | /CertificateManagement/api/v1.0/profiletemplates/{id}/policy/workflow/{type} |
URL 參數
參數 | 描述 |
---|---|
id | 必要。 GUID 對應於要從中擷取原則的設定檔範本。 |
類型 | 必要。 所要求的原則類型。 可能的值為 「Enroll」、「Duplicate」、「OfflineUnblock」、「OnlineUpdate」、「Renew」、「Recovery」、「RecoveryOnBehalf」、「Reinstate」、「Retire」、「Revoke」、「Revoke」、「TemporaryEnroll」和 「Unblock」。 |
要求標頭
如需常見的要求標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭。
要求本文
無。
回應
本節描述回應。
回應碼
程式碼 | 描述 |
---|---|
200 | [確定] |
403 | 禁止 |
204 | 沒有內容 |
500 | 內部錯誤 |
回應標頭
如需常見的回應標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭。
回應本文
成功時,會傳回以 ProfileTemplatePolicy 物件為基礎的原則物件。 根據要求的原則,原則物件至少會包含下表中的屬性,但可以包含其他屬性。 例如,註冊原則的要求會傳回 EnrollPolicy 物件。 如需詳細資訊,請參閱要求中與 {type} 參數相關聯的原則目的檔。 您可以在 Microsoft.Clm.Shared.ProfileTemplates 命名空間 檔中找到不同類型的原則目的檔。
屬性 | 描述 |
---|---|
ApprovalsNeeded | Forefront Identity Manager (FIM) 憑證管理 (CM) 要求所需的核准數目。 |
AuthorizedApprover | 獲授權核准原則之 FIM CM 要求的使用者安全性描述元。 |
AuthorizedEnrollmentAgent | 可做為原則的註冊代理程式之使用者的安全性描述元。 |
AuthorizedInitiator | 可起始原則之 FIM CM 要求的使用者之安全性描述元。 |
CollectComments | 布林值,指出是否為原則的 FIM CM 要求啟用註解集合。 |
CollectRequestPriority | 布林值,指出是否為原則的 FIM CM 要求啟用要求優先順序集合。 |
DefaultRequestPriority | 原則之 FIM CM 要求的預設優先順序。 |
文件 | 針對此原則設定的原則文件。 |
啟用 | 指出是否啟用原則的布林值。 |
EnrollAgentRequired | 布林值,指出原則的 FIM CM 要求是否需要註冊代理程式。 |
OneTimePasswordPolicy | 原則之 FIM CM 要求的一次性密碼散發方法。 |
個人化 | 原則的智慧卡個人化選項。 |
PolicyDataCollection | 與原則相關聯的資料集合項目。 |
SelfServiceEnabled | 布林值,指出是否為原則啟用 FIM CM 要求的自助服務起始。 |
範例
本節提供範例來取得工作流程的設定檔範本原則。
範例:要求 1
GET /CertificateManagement/api/v1.0/profiletemplates/97CD65FA-AF4B-4587-9309-0DD6BFD8B4E1/policies/enroll HTTP/1.1
範例:回應 1
HTTP/1.1 200 OK
... body coming soon
範例:要求 2
GET /CertificateManagement/api/v1.0/profiletemplates/97CD65FA-AF4B-4587-9309-0DD6BFD8B4E1/policies/renew HTTP/1.1
範例:回應 2
HTTP/1.1 200 OK
... body coming soon