Uzyskiwanie ról usługi PAM

  • Artykuł

Używane przez uprzywilejowane konto do wyświetlania listy ról usługi PAM, dla których konto jest kandydatem.

Uwaga

Adresy URL w tym artykule są powiązane z nazwą hosta wybraną podczas wdrażania interfejsu API, na przykład https://api.contoso.com.

Żądanie

Metoda Adres URL żądania
GET /api/pamresources/pamroles

Parametry zapytania

Parametr Opis
$filter Opcjonalny. Określ dowolne właściwości roli PAM w wyrażeniu filtru, aby zwrócić filtrowaną listę odpowiedzi. Aby uzyskać więcej informacji na temat obsługiwanych operatorów, zobacz Filtrowanie w usłudze API REST usługi PAM.
v Opcjonalny. Wersja interfejsu API. Jeśli nie zostanie uwzględniona, zostanie użyta bieżąca (ostatnio wydana) wersja interfejsu API. Aby uzyskać więcej informacji, zobacz Przechowywanie wersji w usłudze INTERFEJSu API REST usługi PAM.

Nagłówki żądań

Aby uzyskać typowe nagłówki żądań, zobacz Nagłówki żądań HTTP i odpowiedzi w szczegółach usługi INTERFEJSu API REST usługi PAM.

Treść żądania

Brak.

Reakcja

W tej sekcji opisano odpowiedź.

Kody odpowiedzi

Kod Opis
200 OK
401 Brak autoryzacji
403 Forbidden
408 Limit czasu żądania
500 Wewnętrzny błąd serwera
503 Usługa niedostępna

Nagłówki odpowiedzi

Aby uzyskać typowe nagłówki żądań, zobacz Nagłówki żądań HTTP i odpowiedzi w szczegółach usługi INTERFEJSu API REST usługi PAM.

Treść odpowiedzi

Pomyślna odpowiedź zawiera kolekcję co najmniej jednej roli usługi PAM, z których każda ma następujące właściwości:

Właściwość Opis
Identyfikator roli Unikatowy identyfikator (GUID) roli PAM.
Nazwa wyświetlana Nazwa wyświetlana roli PAM w usłudze MIM.
Opis Opis roli PAM w usłudze MIM.
TTL Prawa dostępu roli przekraczają limit czasu wygaśnięcia w sekundach.
Dostępne z Najwcześniejsza godzina aktywowania żądania.
Dostępne do Najpóźniejsza godzina aktywowania żądania.
MFAEnabled Wartość logiczna wskazująca, czy żądania aktywacji dla tej roli wymagają wyzwania uwierzytelniania wieloskładnikowego.
ZatwierdzenieEnabled Wartość logiczna wskazująca, czy żądania aktywacji dla tej roli wymagają zatwierdzenia przez właściciela roli.
DostępnośćWindowEnabled Wartość logiczna wskazująca, czy rolę można aktywować tylko w określonym przedziale czasu.

Przykład

Ta sekcja zawiera przykład pobierania ról usługi PAM.

Przykład: żądanie

GET /api/pamresources/pamroles HTTP/1.1

Przykład: odpowiedź

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