Get PAM session info

Article
09/14/2023

Used by a privileged account to get the username of the account that is logged in to the session.

Note

The URLs in this article are relative to the hostname that's chosen during API deployment, such as https://api.contoso.com.

Request

Method	Request URL
GET	/api/session/sessioninfo

Query parameters

Parameter	Description
v	Optional. The API version. If not included, the current (most recently released) version of the API is used. For more information, see Versioning in PAM REST API service details.

Request headers

For common request headers, see HTTP request and response headers in PAM REST API service details.

Request body

None.

Response

This section describes the response.

Response codes

Code	Description
200	OK
401	Unauthorized
403	Forbidden
408	Request Timeout
500	Internal Server Error
503	Service Unavailable

Response headers

For common request headers, see HTTP request and response headers in PAM REST API service details.

Response body

A successful response returns a PAM session object with the following properties:

Property	Description
Username	The username of the account that is logged into this session.

Example

This section provides an example to get the PAM session info.

Example: Request

GET /api/session/sessioninfo/ HTTP/1.1

Example: Response

HTTP/1.1 200 OK

{
    "odata.metadata":"http://localhost:8086/api/pamresources/%24metadata#sessioninfo",
    "value":[
        {
            "Username":"FIMCITONEBOXAD\\Jen"
        }
    ]
}

Share via