PAM ロールを取得する

特権アカウントが、そのアカウントが候補になる PAM ロールの一覧を取得するときに使用します。

Note

この記事の Url は、API の展開時に選択されたホスト名 (など) に関連してい https://api.contoso.com ます。

Request

Method 要求 URL
GET /api/pamresources/pamroles

クエリ パラメーター

パラメーター 説明
$filter 任意。 フィルター式で任意の PAM ロールのプロパティを指定して、フィルター処理された応答のリストを返します。 サポートされている演算子の詳細については、「 PAM でのフィルター処理 REST API サービスの詳細」を参照してください。
v 任意。 API のバージョン。 含まれていない場合は、API の現在 (最新リリース) のバージョンが使用されます。 詳細については、「 PAM REST API サービスの詳細」を参照してください。

要求ヘッダー

一般的な要求ヘッダーについては、「 PAM REST API サービスの詳細」の「 HTTP 要求および応答ヘッダー 」を参照してください。

要求本文

[なし] :

Response

このセクションでは、応答について説明します。

応答コード

コード 説明
200 OK
401 権限がありません
403 Forbidden
408 要求タイムアウト
500 内部サーバー エラー
503 サービス利用不可

応答ヘッダー

一般的な要求ヘッダーについては、「 PAM REST API サービスの詳細」の「 HTTP 要求および応答ヘッダー 」を参照してください。

応答本文

成功応答には、1つまたは複数の PAM ロールのコレクションが含まれます。各ロールには次のプロパティがあります。

プロパティ 説明
RoleID PAM ロールの一意の識別子 (GUID)。
DisplayName MIM サービスの PAM ロールの表示名。
説明 MIM サービスの PAM ロールの説明。
TTL ロールのアクセス権の最長有効期限タイムアウト (秒)。
AvailableFrom 要求がアクティブになる最も早い時刻。
AvailableTo 要求がアクティブになる最も遅い時刻。
MFAEnabled このロールのアクティブ化要求に MFA チャレンジが必要かどうか示すブール値。
ApprovalEnabled このロールのアクティブ化要求にロール所有者の承認が必要かどうか示すブール値。
AvailabilityWindowEnabled 指定した期間中にのみロールをアクティブ化できるかどうかを示すブール値。

このセクションでは、PAM ロールを取得する例を示します。

例: 要求

GET /api/pamresources/pamroles HTTP/1.1

例: Response

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
        }
    ]
}