要求を作成
Microsoft Identity Manager (MIM) 証明書管理 (CM) 要求を作成します。
注意
この記事の URL は、API のデプロイ中に選択されたホスト名 (など https://api.contoso.com
) に対して相対的です。
Request
Method | 要求 URL |
---|---|
POST | /CertificateManagement/api/v1.0/requests |
URL パラメーター
なし。
要求ヘッダー
一般的な要求ヘッダーについては、「CM REST API サービスの詳細」の HTTP 要求ヘッダーと応答ヘッダーに関するページを参照してください。
要求本文
要求本文には、次のプロパティが含まれています。
プロパティ | 説明 |
---|---|
profiletemplateuuid | 必須です。 ユーザーが要求を作成するプロファイル テンプレートの GUID です。 |
datacollection | 必須です。 登録者によって指定されるデータを表す、名前と値のペアのコレクションです。 指定しなければならない必要データのコレクションは、プロファイル テンプレートのワークフロー ポリシーから取得できます。 空のコレクションを指定できます。 |
ターゲット (target) | 省略可能。 要求を作成する対象であるターゲット ユーザーの GUID です。 指定しない場合、ターゲットは既定で現在のユーザーに設定されます。 |
type | 必須です。 作成される要求の種類です。 使用可能な要求の種類には、"登録"、"複製"、"OfflineUnblock"、"OnlineUpdate"、"更新"、"Recover"、"RecoverOnBehalf"、"Reinstate"、"Retire"、"Revoke"、"TemporaryCards"、"ブロック解除" などがあります。 注: すべての要求の種類が、すべてのプロファイル テンプレートでサポートされているわけではありません。 たとえば、ソフトウェア プロファイル テンプレートでブロック解除操作を指定することはできません。 |
コメント | 必須です。 ユーザーが入力する場合があるコメントです。 ワークフロー ポリシーは、コメント プロパティが必要かどうかを定義します。 空の文字列を指定することができます。 |
priority | 省略可能。 要求の優先度です。 指定しない場合は、プロファイル テンプレート設定によって決定される既定の要求優先度が使用されます。 |
Response
このセクションでは、応答について説明します。
応答コード
コード | 説明 |
---|---|
201 | 作成済み |
403 | Forbidden |
500 | 内部エラー |
応答ヘッダー
一般的な応答ヘッダーについては、「CM REST API サービスの詳細」の HTTP 要求ヘッダーと応答ヘッダーに関するページを参照してください。
応答本文
成功すると、新しく作成された要求の URI を返します。
例
このセクションでは、登録要求を作成し、要求のブロックを解除する例を示します。
例: 要求 1
POST /CertificateManagement/api/v1.0/requests HTTP/1.1
{
"datacollection":"[]",
"type":"Enroll",
"profiletemplateuuid":"a039b4d0-5ce8-4eff-8651-181c6576fda3",
"comment":""
}
例: 応答 1
HTTP/1.1 201 Created
"api/v1.0/requests/a9b4b42c-cc50-4c9b-89d1-bbc0bcd5a099"
例: 要求 2
POST /CertificateManagement/api/v1.0/requests HTTP/1.1
{
"datacollection":"[]",
"type":"Unblock",
"smartcard":"17cf063d-e337-4aa9-a822-346554ddd3c9",
"comment":""
}
例: 応答 2
HTTP/1.1 201 Created
"api/v1.0/requests/0c96d73f-967b-420e-854a-43ad2a1504bc"
例: 要求 3
POST /CertificateManagement/api/v1.0/requests HTTP/1.1
{
"profiletemplateuuid" : "97CD65FA-AF4B-4587-9309-0DD6BFD8B4E1",
"datacollection":
[
{"name" : "pavle"},
{"city" : "seattle"}
],
"target" : "97CC3493-F556-4C9B-9D8B-982434201527",
"type" : "Enroll",
"comment" : "LALALALA",
"priority" : "4"
}
関連項目
- Microsoft.Clm.Provision.RequestOperations.InitiateEnroll メソッド
- Microsoft.Clm.Provision.RequestOperations.InitiateOfflineUnblock メソッド
- Microsoft.Clm.Provision.RequestOperations.InitiateRecover メソッド
- Microsoft.Clm.Provision.RequestOperations.InitiateRetire メソッド
- Microsoft.Clm.Provision.RequestOperations.InitiateUnblock メソッド