Hämta PAM-roller

Artikel
09/14/2023

Används av ett privilegierat konto för att lista de PAM-roller som kontot är kandidat för.

Anteckning

URL:erna i den här artikeln är relativa till det värdnamn som väljs under API-distributionen, till exempel https://api.contoso.com.

Förfrågan

Metod	Begärans-URL
GET	/api/pamresources/pamroles

Frågeparametrar

Parameter	Beskrivning
$filter	Valfritt. Ange någon av PAM-rollegenskaperna i ett filteruttryck för att returnera en filtrerad lista med svar. Mer information om operatorer som stöds finns i Filtrering i PAM REST API-tjänstinformation.
v	Valfritt. API-versionen. Om den inte ingår används den aktuella (senast utgivna) versionen av API:et. Mer information finns i Versionshantering i PAM REST API-tjänstinformation.

Begärandehuvuden

Vanliga begärandehuvuden finns i HTTP-begärande- och svarshuvuden i PAM REST API-tjänstinformation.

Begärandetext

Inga.

Svarsåtgärder

I det här avsnittet beskrivs svaret.

Svarskoder

Kod	Description
200	OK
401	Behörighet saknas
403	Förbjudet
408	Timeout för begäran
500	Internt serverfel
503	Tjänsten är inte tillgänglig

Svarshuvuden

Vanliga begärandehuvuden finns i HTTP-begärande- och svarshuvuden i PAM REST API-tjänstinformation.

Själva svaret

Ett lyckat svar innehåller en samling med en eller flera PAM-roller som var och en har följande egenskaper:

Egenskap	Beskrivning
RoleID	Den unika identifieraren (GUID) för PAM-rollen.
DisplayName	Pam-rollens visningsnamn i MIM-tjänsten.
Description	PAM-rollens beskrivning i MIM-tjänsten.
TTL	Den maximala tidsgränsen för förfallotid för rollens åtkomsträttigheter i sekunder.
TillgängligtFrån	Den tidigaste tiden på dagen när en begäran aktiveras.
AvailableTo	Den senaste tiden på dagen när en begäran aktiveras.
MFAEnabled	Ett booleskt värde som anger om aktiveringsbegäranden för den här rollen kräver en MFA-utmaning.
ApprovalEnabled	Ett booleskt värde som anger om aktiveringsbegäranden för den här rollen kräver godkännande av en rollägare.
AvailabilityWindowEnabled	Ett booleskt värde som anger om rollen bara kan aktiveras under ett angivet tidsintervall.

Exempel

Det här avsnittet innehåller ett exempel för att hämta PAM-rollerna.

Exempel: Begäran

GET /api/pamresources/pamroles HTTP/1.1

Exempel: Svar

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

Dela via