Hämta PAM-rollerGet PAM Roles

Används av ett privilegierat konto för att visa en lista med PAM-roller som kontot är en kandidat.Used by a privileged account to list the PAM roles for which the account is a candidate.

Obs: URL: er som visas i det här avsnittet är i förhållande till värdnamnet valt under distributionen av API, till exempel: http://api.contoso.com.Note: URLs shown in this topic are relative to the hostname chosen during API deployment; for example: http://api.contoso.com.

BegäranRequest

MetodMethod URL-begäranRequest URL
GETGET /API/pamresources/pamroles/api/pamresources/pamroles

FrågeparametrarQuery Parameters

ParameterParameter BeskrivningDescription
$filter$filter Valfritt.Optional. Ange någon av egenskaperna för PAM Role i ett filteruttryck för att returnera en filtrerad lista över svar.Specify any of the PAM Role properties in a filter expression to return a filtered list of responses. Mer information om stöds operatorer finns filtrering i information om PAM REST API-tjänstenFor more information about supported operators, see Filtering in PAM REST API Service Details
vv Valfritt.Optional. API-versionen.The API version. Om inte ingår, används den aktuella (mest nyligen utgivna) versionen av API: et.If not included, the current (most recently released) version of the API will be used. Mer information finns i versionshantering i information om PAM REST API-tjänstenFor more information, see Versioning in PAM REST API Service Details

Huvuden för begäranRequest Headers

Vanliga begärandehuvuden finns HTTP-begäran och svarshuvuden i information om PAM REST API-tjänsten.For common request headers, see HTTP Request and Response Headers in PAM REST API Service Details.

BegärandetextenRequest Body

ingetnone

SvarResponse

SvarskoderResponse Codes

KodCode BeskrivningDescription
200200 OKOK
401401 ObehörigUnauthorized
403403 Tillåts inteForbidden
408408 Tidsgräns för förfråganRequest Timeout
500500 Internt serverfelInternal Server Error
503503 Tjänsten är inte tillgängligService Unavailable

SvarsrubrikerResponse Headers

Vanliga svarshuvuden finns HTTP-begäran och svarshuvuden i information om PAM REST API-tjänsten.For common response headers, see HTTP Request and Response Headers in PAM REST API Service Details.

SvarstextenResponse Body

Ett lyckat svar innehåller en samling av en eller flera PAM-roller, som har följande egenskaper.A successful response contains a collection of one or more PAM roles, each of which has the following properties.

EgenskapProperty BeskrivningDescription
RoleIDRoleID Den unika identifieraren (GUID) för PAM-roll.The unique identifier (GUID) of the PAM role.
DisplayNameDisplayName Visningsnamn för PAM-roll i MIM-tjänsten.THe PAM role’s display name in the MIM service.
BeskrivningDescription Beskrivning av PAM-roll i MIM-tjänsten.The PAM role’s description in the MIM service.
TTLTTL Rollens åtkomstbehörigheter maximala giltighetstid tidsgräns i sekunder.The role’s access rights maximum expiration timeout in seconds.
AvailableFromAvailableFrom Den tidigaste tidpunkten på dagen som en requst aktiveras.The earliest time of day that a requst will be activated.
AvailableToAvailableTo Senaste tid på dagen som en begäran aktiveras.The latest time of day that a request will be activated.
MFAEnabledMFAEnabled Ett booleskt värde som anger om aktiveringsbegäranden för den här rollen kräver MFA-kontrollen.A Boolean value that indicates whether activation requests for this role require an MFA challenge.
ApprovalEnabledApprovalEnabled Ett booleskt värde som anger om aktiveringsbegäranden för den här rollen kräver godkännande av en rollägare.A Boolean value that indicates whether activation requests for this role require approval by a role owner.
AvailibitlyWindowEnabledAvailibitlyWindowEnabled Ett booleskt värde som anger om rollen som bara kan aktiveras under ett angivet tidsintervall.A Boolean value that indicates whether the role can only be activated during a specified time interval.

ExempelExample

BegäranRequest

GET /api/pamresources/pamroles HTTP/1.1

SvarResponse

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