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
    • Integration API routes
    • 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

Update the user profile for the active user

Deprecated
PUT
http://localhost:3000/profile/update
PUT
/profile/update
$curl -X PUT http://localhost:3000/profile/update \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{
>  "username": "john_doe"
>}'
1{
2  "provenance": "Local AAA",
3  "username": "john_doe",
4  "firstname": "John",
5  "memberOf": [
6    {
7      "aaaManaged": true,
8      "groupId": "5cb7b531d06cceb89fd21b1c"
9    }
10  ],
11  "assignedRoles": [
12    {
13      "roleId": "5cb7b531d06cceb89fd21b1c"
14    }
15  ],
16  "inactive": true,
17  "gitTokens": {
18    "GitHub": "string",
19    "GitLab": "string"
20  },
21  "lastLogin": "2018-08-02T15:56:12.912Z",
22  "sso": true,
23  "nameID": "string",
24  "_meta": {
25    "created": "2018-08-02T15:56:12.912Z",
26    "updated": "2018-08-02T15:56:12.912Z"
27  },
28  "email": "name@email.com",
29  "isServiceAccount": true,
30  "loggedIn": true
31}
Updates the user profile for the active user.
Was this page helpful?
Previous

Create a group

Next
Built with

Authentication

AuthorizationBasic

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

Request

userProfile
usernamestringRequired
Username for account
emailstringOptional
Email for user

Response

Updated account document for current user
provenancestring
AAA provider where account originated
usernamestring
Username for account
firstnamestring
The user's first name
memberOflist of objects
Groups which this account is a part of
assignedRoleslist of objects
Roles assigned to this account
inactiveboolean
Setting for whether account is active or not
gitTokensobject
Tokens used when interacting with Git APIs and features
lastLoginstring
Date and time when the user last logged in
ssoboolean
Whether this is an SSO user
nameIDstring

DEPRECATED: Identifier for SSO account.

_metaobject
emailstring
Email for user
isServiceAccountboolean
Value denoting if an account does not reflect a human user
loggedInboolean
Property used in the getAccounts API to indicate a user is currently logged in

Errors

500
Internal Server Error