XPxpansiv
Users

Edit user details

Updates user details on the caller's active account. Requires EM_ACCOUNT.USER edit permission. The target user is identified by login and must belong to the active account. Required fields: login, firstName, lastName, and status.

post/users/action/edit

Request

Request body

firstNamestring required

Must not contain digits (0-9). Special characters are allowed. Same validation as legacy EMA UI.

middleNamestring

Must not contain digits (0-9). Special characters are allowed. Same validation as legacy EMA UI.

lastNamestring required

Must not contain digits (0-9). Special characters are allowed. Same validation as legacy EMA UI.

emailstring email required
jobTitlestring required
telephonestring
authSubjectstring
loginstring

User login name. Required when editing an existing user.

organizationRelationshipstring

Ref.Data.USER_ORGANIZATION_RELATIONSHIP

rolesUserRole[]

Account-scoped entitlement roles only.

statusstring

Ref.Data.USER_STATUS

lastLoginstring date-time

Last login timestamp

isAdminboolean

Example request

{
  "firstName": "John",
  "middleName": "Jackson",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Portfolio Manager",
  "telephone": "555-123-4567",
  "authSubject": "auth0|asdfghjkl1234567890",
  "login": "johndoe",
  "address": {
    "postalCode": "12345",
    "city": "New York",
    "addressLineOne": "5 Broadway",
    "addressLineTwo": "5th floor"
  },
  "account": {
    "identifier": "0980A123",
    "status": "APPROVED",
    "organization": {
      "legalName": "RVCMC Sub Default",
      "structure": "PRIVATELY_OWNED_CORP",
      "type": "BROKER"
    },
    "services": [
      {
        "status": "APPROVED",
        "type": "ACX",
        "attributes": {
          "retirementSubaccountCodes": {
            "ACR": [
              "12345"
            ],
            "CAR": [],
            "VCS": [
              "43134",
              "32141"
            ]
          },
          "linkedRegistryAccountIds": {
            "ACR": "098765",
            "CAR": null,
            "VCS": "567890"
          }
        }
      }
    ]
  }
}

Response

Updated user

firstNamestring required

Must not contain digits (0-9). Special characters are allowed. Same validation as legacy EMA UI.

middleNamestring

Must not contain digits (0-9). Special characters are allowed. Same validation as legacy EMA UI.

lastNamestring required

Must not contain digits (0-9). Special characters are allowed. Same validation as legacy EMA UI.

emailstring email required
jobTitlestring required
telephonestring
authSubjectstring
loginstring

User login name. Required when editing an existing user.

organizationRelationshipstring

Ref.Data.USER_ORGANIZATION_RELATIONSHIP

rolesUserRole[]

Account-scoped entitlement roles only.

statusstring

Ref.Data.USER_STATUS

lastLoginstring date-time

Last login timestamp

isAdminboolean

Example response

{
  "firstName": "John",
  "middleName": "Jackson",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "jobTitle": "Portfolio Manager",
  "telephone": "555-123-4567",
  "authSubject": "auth0|asdfghjkl1234567890",
  "login": "johndoe",
  "address": {
    "postalCode": "12345",
    "city": "New York",
    "addressLineOne": "5 Broadway",
    "addressLineTwo": "5th floor"
  },
  "account": {
    "identifier": "0980A123",
    "status": "APPROVED",
    "organization": {
      "legalName": "RVCMC Sub Default",
      "structure": "PRIVATELY_OWNED_CORP",
      "type": "BROKER"
    },
    "services": [
      {
        "status": "APPROVED",
        "type": "ACX",
        "attributes": {
          "retirementSubaccountCodes": {
            "ACR": [
              "12345"
            ],
            "CAR": [],
            "VCS": [
              "43134",
              "32141"
            ]
          },
          "linkedRegistryAccountIds": {
            "ACR": "098765",
            "CAR": null,
            "VCS": "567890"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.