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 principal document for the active user

GET
http://localhost:3000/myPrincipal
GET
/myPrincipal
$curl http://localhost:3000/myPrincipal \
>     -u "<username>:<password>"
1{
2  "id": "5cb7b531d06cceb89fd21b1c",
3  "provenance": "Local AAA",
4  "username": "jane_doe",
5  "firstname": "Jane",
6  "groups": [
7    {
8      "id": "5cb7b531d06cceb89fd21b1c",
9      "provenance": "Local AAA",
10      "name": "admin_group"
11    }
12  ],
13  "roles": [
14    "5cb7b531d06cceb89fd21b1c"
15  ],
16  "roleNames": [
17    "string"
18  ],
19  "allowedMethods": [
20    {
21      "provenance": "AutomationStudio",
22      "name": "getTemplates"
23    }
24  ],
25  "allowedViews": [
26    {
27      "provenance": "AutomationStudio",
28      "path": "/automation-studio/"
29    }
30  ],
31  "routes": [
32    "/admin/"
33  ]
34}
Returns the principal for the active user.
Was this page helpful?
Previous

Get the session document for the active user

Next
Built with

Authentication

AuthorizationBasic

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

Response

The principal document for the logged in user
idstringformat: "^[0-9a-f]{24}$"
String representation of a MongoDB ObjectId
provenancestring
The name of the AAA adapter from which the user logged in
usernamestring
The username of the logged in user
firstnamestring
The first name of the logged in user
groupslist of objects
An array of groups which contain the logged in user
roleslist of strings
Array of roles user has access to
roleNameslist of strings
Array of role names user has access to
allowedMethodslist of objects
The API methods which a user has access to
allowedViewslist of objects
The URL pages which a user has access to
routeslist of strings
Array of routes logged in user has access to

Errors

500
Internal Server Error