Skapa PAM-förfråganCreate PAM Request

Används av ett konto med privilegier för att upphöja till en PAM-roll.Used by a privileged account to elevate to a PAM role.

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
POSTPOST /API/pamresources/pamrequests/api/pamresources/pamrequests

FrågeparametrarQuery Parameters

ParameterParameter BeskrivningDescription
MotiveringenJustification Valfritt.Optional. Användaren har angett orsaken för höjning begäran.The user-supplied reason for the elevation request.
RoleIdRoleId Obligatoriskt.Required. Den unika identifieraren (GUID) för PAM-roll att upphöja till.The unique identifier (GUID) of the PAM role to elevate to.
RequestedTTLRequestedTTL Obligatoriskt.Required. Den begärda förfallotiden, i sekunder.The requested expiration time, in seconds.
RequestedTimeRequestedTime Optoinal.Optoinal. Tid att upphöja behörighet.The time to elevate privileges.
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

Obs: du kan ange den motivering, RoleId, RequestedTTL, och RequestedTime parametrar som egenskaper i frågans brödtext i stället för som Frågeparametrar.Note: You can specify the Justification, RoleId, RequestedTTL, and RequestedTime parameters as properties in the request body, rather than as query parameters. Den v parameteer kan bara anges som en frågeparameter.The v parameteer can only be specified as a query parameter.

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

Valfritt.Optional. Som nämnts ovan är de motivering, RoleId, RequestedTTL, och RequestedTime parametrar kan anges som egenskaperna för en begärantext i stället för att ange dem i URL: en frågesträng.As noted above, the Justification, RoleId, RequestedTTL, and RequestedTime paramters can be specified as properties of a request body instead of specifying them in the URL query string.

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 PAM-begäran med följande egenskaper.A successful response contains a PAM request object with the following properties.

EgenskapProperty BeskrivningDescription
Begärande-IDRequestID Den unika identifieraren (GUID) för PAM-förfrågan.The unique identifier (GUID) for the PAM request.
CreatorIDCreatorID Den unika identifieraren (GUID) i MIM-tjänsten för det konto som skapats av begäran.The unique identifier (GUID) in the MIM service for the account that created the request.
MotiveringenJustification Orsak för höjning.The reason for elevation.
SkapadTidCreationTime Skapandetid för begäran.The creation time of the request.
CreationMethodCreationMethod Den metod som används för att skapa begäran.The method used to create the request.
ExpirationTimeExpirationTime Förfallotid för begäran.The expiration time of the request.
RoleIDRoleID Den unika identifieraren (GUID) för PAM-roll.The unique identifier (GUID) of the PAM role.
RequestedTTLRequestedTTL Den begärda giltighetstid tidsgränsen i sekunder.The requested expiration timeout in seconds.
RequestedTimeRequestedTime Den begärda tiden för höjning.The requested time for elevation.
RequestStatusRequestStatus Status för begäran.The status of the request. Möjliga värden är: ”bearbetning”, ”aktiv”, ”stängd”, ”Closing”, ”upphört att gälla”, ”väntar på godkännande”, ”PendingMFA” och ”avvisade”.Possible values are: "Processing", "Active", "Closed", "Closing", "Expired", "PendingApproval", "PendingMFA" and "Rejected".

ExempelExample

Begäran 1Request 1

POST /api/pamresources/pamrequests?Justification=Sample+Reason&RoleId=c28eab4a-95cf-4c08-a153-d5e8a9e660cd&RequestedTTL=7200&RequestedTime=2015%2F07%2F11+23%3A40 HTTP/1.1

Svar 1Response 1

HTTP/1.1 201 Created

{  
    "odata.metadata":"http://localhost:8086/api/pamresources/%24metadata#pamrequests/@Element",
    "RequestId":"c0112f13-b16b-40ad-b547-07f23a7fba52",
    "CreatorID":"73257e5e-00b3-4309-a330-f1e607ff113a",
    "Justification":"Sample Reason",
    "CreationTime":"2015-07-11T23:38:09.036164-07:00",
    "CreationMethod":"PAM Web API",
    "ExpirationTime":"0001-01-01T00:00:00",
    "RoleId":"c28eab4a-95cf-4c08-a153-d5e8a9e660cd",
    "RequestedTTL":"7200",
    "RequestedTime":"2015-07-12T06:40:00Z",
    "RequestStatus":"PendingApproval"
}

Förfrågan 2Request 2

POST /api/pamresources/pamrequests?Justification=&RoleId=c28eab4a-95cf-4c08-a153-d5e8a9e660cd&RequestedTTL=3600&RequestedTime= HTTP/1.1

Svar 2Response 2

HTTP/1.1 201 Created

{
    "odata.metadata":"http://localhost:8086/api/pamresources/%24metadata#pamrequests/@Element",
    "RequestId":"504f9c49-00db-42bd-a157-ee5664617189",
    "CreatorID":"73257e5e-00b3-4309-a330-f1e607ff113a",
    "Justification":null,
    "CreationTime":"2015-07-11T23:07:30.2200123-07:00",
    "CreationMethod":"PAM Web API",
    "ExpirationTime":"0001-01-01T00:00:00",
    "RoleId":"c28eab4a-95cf-4c08-a153-d5e8a9e660cd",
    "RequestedTTL":"3600",
    "RequestedTime":"2015-07-12T06:07:27.7229894Z",
    "RequestStatus":"PendingApproval"
}