取得 PAM 角色

用來列出此帳戶的候選 PAM 角色的權限帳戶。

注意

本文中的 Url 會相對於 API 部署期間所選擇的主機名稱,例如 https://api.contoso.com

要求

方法 要求 URL
GET /api/pamresources/pamroles

查詢參數

參數 描述
$filter 選擇性。 在篩選條件運算式中指定任何 PAM 角色屬性來傳回篩選的回應清單。 如需有關支援的運算子的詳細資訊,請參閱 PAM REST API 服務詳細資料中的篩選
v 選擇性。 API 版本。 如果未包含,則會使用目前的 (最近發行的) 版本的 API。 如需詳細資訊,請參閱 PAM REST API 服務詳細資料中的版本設定。

要求標頭

關於常見的要求標頭,請參閱PAM REST API 服務詳細資料中的HTTP 要求和回應標頭

要求本文

無。

回應

本節說明回應。

回應碼

程式碼 描述
200 [確定]
401 未經授權
403 禁止
408 要求逾時
500 內部伺服器錯誤
503 服務無法使用

回應標頭

關於常見的要求標頭,請參閱PAM REST API 服務詳細資料中的HTTP 要求和回應標頭

回應本文

成功的回應會包含一或多個 PAM 角色的集合,其中每個角色都有下列屬性:

屬性 描述
RoleID PAM 角色的唯一識別碼 (GUID)。
DisplayName MIM 服務中 PAM 角色的顯示名稱。
描述 MIM 服務中 PAM 角色的描述。
TTL 角色的存取權利到期逾時上限 (以秒為單位)。
AvailableFrom 開始要求的最早時間。
AvailableTo 開始要求的最晚時間。
MFAEnabled 布林值,指出這個角色的啟用要求是否需要 MFA 挑戰。
ApprovalEnabled 布林值,指出這個角色的啟用要求是否需要經過角色擁有者核淮。
AvailabilityWindowEnabled 布林值,指出是否只能在指定的時間間隔內啟動角色。

範例

本節提供取得 PAM 角色的範例。

範例:要求

GET /api/pamresources/pamroles HTTP/1.1

範例:回應

HTTP/1.1 200 OK

{
    "odata.metadata":"http://localhost:8086/api/pamresources/%24metadata#pamroles",
    "value":[
        {
            "RoleId":"8f5cec1a-ecba-42ec-b76d-e6e0e4bf4c62",
            "DisplayName":"Allow AD Access ",
            "Description":null,
            "TTL":"3600",
            "AvailableFrom":"0001-01-01T00:00:00",
            "AvailableTo":"0001-01-01T00:00:00",
            "MFAEnabled":false,
            "ApprovalEnabled":false,
            "AvailabilityWindowEnabled":false
        },
        {
            "RoleId":"c28eab4a-95cf-4c08-a153-d5e8a9e660cd",
            "DisplayName":"ApprovalRole",
            "Description":null,
            "TTL":"3600",
            "AvailableFrom":"0001-01-01T00:00:00",
            "AvailableTo":"0001-01-01T00:00:00",
            "MFAEnabled":false,
            "ApprovalEnabled":true,
            "AvailabilityWindowEnabled":false
        }
    ]
}