取得要求
取得一或多個指定的MICROSOFT IDENTITY MANAGER (MIM) 憑證管理 (CM) 要求。
注意
本文中的 URL 相對於 API 部署期間所選擇的主機名稱,例如 https://api.contoso.com
。
要求
方法 | 要求 URL |
---|---|
GET | /CertificateManagement/api/v1.0/requests/{id} |
URL 參數
屬性 | 描述 |
---|---|
id | 選擇性。 要擷取之要求的 GUID。 |
查詢參數
屬性 | 描述 |
---|---|
targetuser | 選擇性。 要求的目標使用者。 如果未指定任何目標,則不論目標使用者都傳回所有要求。 注意:目前僅支援 「current」 值。 |
status | 選擇性。 指出要擷取的要求狀態。 可能的狀態類型為「已核准」、「已取消」、「已完成」、「拒絕」、「執行中」、「失敗」、「無」和「擱置」。 如果未指定任何狀態,則不論傳回狀態為何,所有要求都會傳回。 |
要求標頭
如需常見的要求標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭。
要求本文
無。
回應
本節描述回應。
回應碼
程式碼 | 描述 |
---|---|
200 | [確定] |
204 | 沒有內容 |
403 | 禁止 |
500 | 內部錯誤 |
回應標頭
如需常見的回應標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭。
回應本文
成功時,會傳回一個或多個包含下列屬性的 Request 物件:
名稱 | 描述 |
---|---|
註解 | 與 MIM CM 要求相關聯的註解。 |
已完成 | MIM CM 要求的完成時間。 |
DataCollection | 與 MIM CM 要求相關聯的資料收集項目。 |
DataCollectionFlags | MIM CM 要求的資料收集的選項。 |
Flags | MIM CM 要求相關聯的選項。 |
IsDataCollectionComplete | 布林值,指出是否已完成 MIM CM 要求的資料收集。 |
IsEnrollmentAgent | 布林值,指出是否需要註冊代理程式來執行 MIM CM 要求。 |
IsSmartcard | 布林值,指出如果 MIM CM 要求是智慧卡要求還是軟體設定檔要求。 |
NewProfileUuid | MIM CM 要求所產生的新軟體設定檔身分。 |
NewSmartcardUuid | MIM CM 要求所指派的新智慧卡身分。 |
OldProfileUuid | 建立 MIM CM 要求的軟體設定檔身分。 |
OldSmartcardUuid | 建立 MIM CM 要求的暫慧卡身分。 |
OriginatorUserUuid | 產生 MIM CM 要求之使用者的身分識別。 |
優先順序 | MIM CM 要求的優先順序。 |
ProfileTemplateUuid | 建立 MIM CM 要求的設定檔範本的身分。 |
RequestType | MIM CM 要求的類型。 |
SecurityDescriptor | MIM CM 要求的安全性描述元。 |
狀態 | MIM CM 要求的狀態。 |
已提交 | 已提交 MIM CM 要求的時間。 |
TargetUserUuid | MIM CM 要求的目標使用者身分。 |
Uuid | MIM CM 要求的識別碼。 |
範例
本節提供取得指定 MIM CM 要求的範例。
範例:要求 1
GET /certificatemanagement/api/v1.0/requests/a9b4b42c-cc50-4c9b-89d1-bbc0bcd5a099 HTTP/1.1
範例:回應 1
HTTP/1.1 200 OK
{
"Uuid":"a9b4b42c-cc50-4c9b-89d1-bbc0bcd5a099",
"RequestType":1,
"Status":3,
"Flags":2,
"DataCollection":[
],
"DataCollectionFlags":32,
"OriginatorUserUuid":"8f1590dc-d932-4b66-8e68-2e91c5880780",
"TargetUserUuid":"8f1590dc-d932-4b66-8e68-2e91c5880780",
"Submitted":"2015-07-07T23:36:21.93Z",
"Completed":"0001-01-01T00:00:00",
"NewProfileUuid":"00000000-0000-0000-0000-000000000000",
"OldProfileUuid":"00000000-0000-0000-0000-000000000000",
"NewSmartcardUuid":"00000000-0000-0000-0000-000000000000",
"OldSmartcardUuid":"00000000-0000-0000-0000-000000000000",
"Priority":0,
"Comment":"",
"ProfileTemplateUuid":"a039b4d0-5ce8-4eff-8651-181c6576fda3",
"SecurityDescriptor":"O:S-1-5-21-2127521184-1604012920-1887927527-14134865D:(D;;LC;;;S-1-5-21-2127521184-1604012920-1887927527-14995557)(A;;DCSW;;;S-1-5-21-2127521184-1604012920-1887927527-5094533)(A;;DCSW;;;S-1-5-21-2127521184-1604012920-1887927527-5094534)(A;;DCSW;;;S-1-5-21-2127521184-1604012920-1887927527-5219125)(A;;SWRC;;;S-1-5-21-2127521184-1604012920-1887927527-5094533)(A;;RC;;;WD)(A;;CCDCLCSWSDRC;;;S-1-5-21-2127521184-1604012920-1887927527-14134865)(A;;DCSW;;;S-1-5-21-2127521184-1604012920-1887927527-14995557)(A;;CCDCSW;;;S-1-5-21-2127521184-1604012920-1887927527-14995557)\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000\u0000",
"IsSmartcard":true,
"IsEnrollmentAgent":false,
"IsDataCollectionComplete":false
}
範例:要求 2
GET /certificatemanagement/api/v1.0/requests/0c96d73f-967b-420e-854a-43ad2a1504bc HTTP/1.1
範例:回應 2
HTTP/1.1 200 OK
{
"Uuid":"0c96d73f-967b-420e-854a-43ad2a1504bc",
"RequestType":5,
"Status":3,
"Flags":2,
"DataCollection":[
{
"Name":"Sample Data Item",
"Value":null
}
],
"DataCollectionFlags":32,
"OriginatorUserUuid":"8f1590dc-d932-4b66-8e68-2e91c5880780",
"TargetUserUuid":"8f1590dc-d932-4b66-8e68-2e91c5880780",
"Submitted":"2015-07-07T23:40:33.133Z",
"Completed":"0001-01-01T00:00:00",
"NewProfileUuid":"b99ff38c-6653-471f-ae3c-325bb351a6bc",
"OldProfileUuid":"b99ff38c-6653-471f-ae3c-325bb351a6bc",
"NewSmartcardUuid":"17cf063d-e337-4aa9-a822-346554ddd3c9",
"OldSmartcardUuid":"17cf063d-e337-4aa9-a822-346554ddd3c9",
"Priority":0,
"Comment":"",
"ProfileTemplateUuid":"a039b4d0-5ce8-4eff-8651-181c6576fda3",
"SecurityDescriptor":"O:S-1-5-21-2127521184-1604012920-1887927527-14134865D:(D;;LC;;;S-1-5-21-2127521184-1604012920-1887927527-14995557)(A;;SWRC;;;S-1-5-21-2127521184-1604012920-1887927527-5094533)(A;;RC;;;WD)(A;;CCDCLCSWSDRC;;;S-1-5-21-2127521184-1604012920-1887927527-14134865)(A;;DCSW;;;S-1-5-21-2127521184-1604012920-1887927527-14995557)(A;;CCDCSW;;;S-1-5-21-2127521184-1604012920-1887927527-14995557)\u0000\u0000\u0000\u0000\u0000\u0000",
"IsSmartcard":true,
"IsEnrollmentAgent":false,
"IsDataCollectionComplete":false
}