Uzyskiwanie ról pam

Używane przez uprzywilejowane konto do listy ról PAM, dla których konto jest kandydatem.

Uwaga

Adresy URL w tym artykule są względne względem nazwy hosta wybranej podczas wdrażania interfejsu API, takiej jak https://api.contoso.com .

Żądanie

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

Parametry zapytania

Parametr Opis
$filter Opcjonalny. Określ dowolną z 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 Filtering in PAM REST API service details (Filtrowanie w usłudze interfejsu API REST usługi PAM).
v Opcjonalny. Wersja interfejsu API. Jeśli nie zostanie uwzględniony, zostanie użyta bieżąca (ostatnio wydana) wersja interfejsu API. Aby uzyskać więcej informacji, zobacz Versioning in PAM REST API service details (Obsługa wersji w usłudze interfejsu API REST usługi PAM).

Nagłówki żądań

Typowe nagłówki żądań można znaleźć w sekcji Http request and response headers (Nagłówki żądań i odpowiedzi HTTP) w tesłudze szczegółów 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

Typowe nagłówki żądań można znaleźć w sekcji Http request and response headers (Nagłówki żądań i odpowiedzi HTTP) w tesłudze szczegółów usługi interfejsu API REST usługi PAM.

Treść odpowiedzi

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

Właściwość Opis
RoleID Unikatowy identyfikator (GUID) roli PAM.
Nazwa wyświetlana Nazwa wyświetlana roli pam w usłudze MIM pam.
Opis Opis roli PAM w usłudze MIM usługi.
TTL Maksymalny limit czasu wygaśnięcia praw dostępu roli w sekundach.
Dostępne od Najwcześniejsza godzina dnia aktywowania żądania.
Dostępne do Najpóźniejsza godzina 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.
AvailabilityWindowEnabled Wartość logiczna wskazująca, czy rolę można aktywować tylko w określonym przedziale czasu.

Przykład

Ta sekcja zawiera przykład, w których można pobrać role 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
        }
    ]
}