指定したワークフローのプロファイル テンプレート ポリシーを取得します。 データは要求の作成時に使用されます。 ワークフロー ポリシーは、要求を作成するためにクライアントが必要とするデータを指定します。 データには、さまざまなデータ収集項目、要求コメント、ワンタイム パスワード ポリシーを含めることができます。
注
この記事の URL は、https://api.contoso.comなど、API のデプロイ時に選択されたホスト名を基準にしています。
依頼
| メソッド | 要求 URL |
|---|---|
| 取得する | /CertificateManagement/api/v1.0/profiletemplates/{id}/policy/workflow/{type} |
URL パラメーター
| パラメーター | 説明 |
|---|---|
| 識別子 | 必須。 ポリシーの抽出元となるプロファイル テンプレートに対応する GUID。 |
| 種類 | 必須。 要求されているポリシーの種類。 指定できる値は、"Enroll"、"Duplicate"、"OfflineUnblock"、"OnlineUpdate"、"Renew"、"Recover"、"RecoverOnBehalf"、"Reinstate"、"Retire"、"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