取得設定檔資料
取得使用者的軟體憑證配置檔案清單。 此清單包含目前使用者可以執行的可能作業。 然後,任何指定的作業即可起始要求。
重要
只有當設定檔範本原則指出應該完成時,伺服器才會設定 PIN。 否則,使用者應該提供 PIN。
注意
本文中的 URL 相對於 API 部署期間所選擇的主機名稱,例如 https://api.contoso.com
。
要求
方法 | 要求 URL |
---|---|
GET | /CertificateManagement/api/v1.0/profiles /CertificateManagement/api/v1.0/profiles/{id} /CertificateManagement/api/v1.0/requests/{requestid}/profiles |
URL 參數
參數 | 描述 |
---|---|
id | 要傳回之設定檔的識別碼 (GUID)。 |
requestId | 要求的識別碼,表示依該要求傳回設定檔。 |
查詢參數
參數 | 描述 |
---|---|
status | 選擇性。 指出要擷取資料的設定檔狀態。 可能的狀態類型為 「作用中」、「已核准」、「已取消」、「已完成」、「拒絕」、「執行中」、「失敗」、「無」和「擱置」。 如果未指定任何狀態,則不論傳回狀態為何,所有設定檔都會傳回。 |
要求標頭
如需常見的要求標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭。
要求本文
無。
回應
本節描述回應。
回應碼
程式碼 | 描述 |
---|---|
200 | [確定] |
204 | 沒有內容 |
403 | 禁止 |
500 | 內部錯誤 |
回應標頭
如需常見的回應標頭,請參閱CM REST API 服務詳細資料中的HTTP 要求和回應標頭。
回應本文
成功時,會傳回包含下列屬性的 JSON 序列化 Microsoft.Clm.Shared.Profiles.Profile \(英文\) 物件清單:
屬性 | 描述 |
---|---|
AssignedUserUuid | 使用者的識別碼,表示指派設定檔給該使用者。 |
註解 | 描述智慧卡的註解。 |
Flags | 描述設定檔的旗標。 |
ParentProfileUuid | 此智慧卡已取代之舊智慧卡的識別碼。 |
PrimaryProfileUuid | 主要設定檔的識別碼。 |
ProfileOperations | 目前的使用者可以對設定檔執行的可能作業清單。 |
ProfileTemplateUuid | 設定檔範本的識別碼,包含控管該設定檔的原則和設定。 |
ProfileTemplateVersion | 建立設定檔時的設定檔範本版本。 |
狀態 | 設定檔的狀態。 |
Uuid | 設定檔的識別碼。 |
範例
本節提供取得使用者的設定檔資料的範例。
範例:要求
GET /certificatemanagement/api/v1.0/profiles?status=Active HTTP/1.1
範例:回應
HTTP/1.1 200 OK
[
{
"Uuid":"c0dd5c7d-ec35-4346-baca-3ad711e9722f",
"Status":2,
"Flags":1,
"ParentProfileUuid":"1c9e2606-fea2-4048-a6ac-b014e54c22df",
"PrimaryProfileUuid":"00000000-0000-0000-0000-000000000000",
"AssignedUserUuid":"0378a33b-8650-4713-a727-efd233903643",
"ProfileTemplateUuid":"8f31803f-8afc-49bb-911d-402ec264b589",
"ProfileTemplateVersion":8,
"Comment":"",
"ProfileOperations":[
"renew",
"disable",
"recover"
]
},
{
"Uuid":"5ad77b40-aa42-4533-9396-c9c59fd021a8",
"Status":2,
"Flags":1,
"ParentProfileUuid":"00000000-0000-0000-0000-000000000000",
"PrimaryProfileUuid":"00000000-0000-0000-0000-000000000000",
"AssignedUserUuid":"0378a33b-8650-4713-a727-efd233903643",
"ProfileTemplateUuid":"8f31803f-8afc-49bb-911d-402ec264b589",
"ProfileTemplateVersion":8,
"Comment":"",
"ProfileOperations":[
"renew",
"disable",
"recover"
]
},
{
"Uuid":"ff342953-c444-4dc7-b144-f5515d6460c6",
"Status":2,
"Flags":1,
"ParentProfileUuid":"00000000-0000-0000-0000-000000000000",
"PrimaryProfileUuid":"00000000-0000-0000-0000-000000000000",
"AssignedUserUuid":"0378a33b-8650-4713-a727-efd233903643",
"ProfileTemplateUuid":"1e3a31fe-699b-4a6b-945c-18b83c985bc1",
"ProfileTemplateVersion":9,
"Comment":"",
"ProfileOperations":[
"renew",
"disable"
]
}
]