Udostępnij przez


Uzyskiwanie ról usługi PAM

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, taką jak 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 INTERFEJSu 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 zapytań

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

Ciało żądania

Żaden.

Odpowiedź

W tej sekcji opisano odpowiedź.

Kody odpowiedzi

Kod Opis
200 OK
401 Brak autoryzacji
403 Zakazany
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óły usługi INTERFEJSu API REST usługi PAM.

Ciało 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:

Nieruchomość Opis
Identyfikator roli Unikatowy identyfikator (GUID) roli PAM.
Nazwa wyświetlana Nazwa wyświetlana roli PAM THe w usłudze MIM.
Opis Opis roli usługi PAM w usłudze MIM.
TTL Limit czasu wygaśnięcia praw dostępu roli wynosi maksymalnie w sekundach.
DostępneZ Najwcześniejsza godzina rozpoczęcia aktywacji żądania.
Dostępne do Najpóźniejsza pora dnia aktywowania żądania.
MFAEnabled Wartość logiczna wskazująca, czy żądania aktywacji dla tej roli wymagają żądania uwierzytelniania wieloskładnikowego.
ApprovalEnabled 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

W tej sekcji przedstawiono 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":"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
        }
    ]
}