次の方法で共有

PAM ロールを取得する

  • [アーティクル]

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

注意

この記事の URL は、 などの https://api.contoso.comAPI デプロイ中に選択されたホスト名に対する相対 URL です。

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

例: 応答

HTTP/1.1 200 OK

{
    "odata.metadata":"http://localhost:8086/api/pamresources/%24metadata#pamroles",
    "value":[
        {
            "RoleId":"00000000-0000-0000-0000-000000000000",
            "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":"00000000-0000-0000-0000-000000000000",
            "DisplayName":"ApprovalRole",
            "Description":null,
            "TTL":"3600",
            "AvailableFrom":"0001-01-01T00:00:00",
            "AvailableTo":"0001-01-01T00:00:00",
            "MFAEnabled":false,
            "ApprovalEnabled":true,
            "AvailabilityWindowEnabled":false
        }
    ]
}