获取 PAM 角色

项目
09/14/2023

特权帐户用以列出其是候选身份的 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	PAM 角色在 MIM 服务中的显示名称。
说明	PAM 角色在 MIM 服务中的说明。
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
        }
    ]
}

Share via