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
        • POSTCreate a group
        • POSTCreate a role
        • DELDelete a group
        • DELDelete a role
        • GETExtract CSV data of accounts, groups, and roles
        • POSTForce a user to log out
        • GETGet a list of groups
        • GETGet a list of methods
        • GETGet a list of roles
        • GETGet a list of views
        • GETGet a simplified list of groups
        • GETGet an individual account
        • GETGet an individual group
        • GETGet an individual role
        • GETList all accounts
        • PATCHUpdate a group
        • PATCHUpdate a role
        • PATCHUpdate an account
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceAuthorization

Update an account

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

Add one or more components to project

Next
Built with

Authentication

AuthorizationBasic

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

Path parameters

accountIdstringRequiredformat: "^[0-9a-f]{24}$"
The individual account to update.

Request

request body
updatesobjectOptional

Response

The output of the account update.
statusenum
The status of the API request.
Allowed values:
messagestring
Message containing either confirmation of the operation or the reason for the failure of the operation.
dataobject
This is the schema for an IAP account stored in Mongo

Errors

500
Internal Server Error