For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • GETDownload a public file from Itential Platform
        • GETGet authentication metadata
        • GETGet session time-to-live
        • GETGet system server ID
        • GETGet the authorization data for the logged in user
        • GETGet the principal document for the active user
        • GETGet the session document for the active user
        • GETGet the user profile for the active user
        • GETGet version
        • GETGet whether or not single sign on is enabled
        • GETList all application configs
        • POSTLog in and create a session in Itential Platform
        • GETLog in using single sign-on
        • GETLog out of Itential Platform
        • POSTSAML identity provider callback
        • GETTest SSO login configuration
        • PUTUpdate the user profile for the active user
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAuthentication

Get the session document for the active user

GET
http://localhost:3000/mySession
GET
/mySession
$curl http://localhost:3000/mySession \
>     -u "<username>:<password>"
1{
2  "id": "string",
3  "loginMethod": "Web",
4  "session_start": 1,
5  "ttl": 1,
6  "principalId": "string",
7  "requestCount": 1
8}
Returns the session for the active user.
Was this page helpful?
Previous

Get the user profile for the active user

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Response

The session document for the logged in user.
idstring
The session token for the logged in user
loginMethodenum
The way a user logged in
Allowed values:
session_startinteger
The Unix epoch time when the session started
ttlinteger
The default ttl for a user session
principalIdstring
The accountId for the logged in user
requestCountinteger
The number of API requests made during the active session

Errors

500
Internal Server Error