ワークフロー ポリシーを取得する

  • [アーティクル]

指定したワークフローのプロファイル テンプレート ポリシーを取得します。 データは要求の作成時に使用されます。 ワークフロー ポリシーには、クライアントが要求を作成するために必要なデータを指定します。 データには、さまざまなデータ収集項目、要求コメント、およびワンタイム パスワード ポリシーを含めることができます。

注意

この記事の URL は、API のデプロイ中に選択されたホスト名 (など https://api.contoso.com) に対して相対的です。

Request

Method 要求 URL
GET /CertificateManagement/api/v1.0/profiletemplates/{id}/policy/workflow/{type}

URL パラメーター

パラメーター 説明
id 必須。 ポリシーを抽出するプロファイル テンプレートに対応する GUID。
type 必須です。 要求されているポリシーの種類。 指定できる値は、"Enroll"、"Duplicate"、"OfflineUnblock"、"OnlineUpdate"、"Renew"、"Recover"、"RecoverOnBehalf"、"Reinstate"、"Retire"、"Revoke"、"TemporaryEnroll"、および "Unblock" です。

要求ヘッダー

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

要求本文

なし。

Response

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

応答コード

コード 説明
200 OK
403 Forbidden
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 要求の既定の優先度。
Documents ポリシーに構成されているポリシー ドキュメント。
Enabled ポリシーが有効かどうかを示すブール値。
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

関連項目