XPxpansiv
Users

Search users

Search users scoped to the caller's active account. Requires EM_ACCOUNT.USER edit permission on the active account. If accountIdentifier is supplied it must match the active account.

post/users/action/search

Request

Query parameters

pageinteger
sizeinteger
includestring

Comma-separated values from optional response fields

Request body

accountIdentifierstring

Account identifier. Callers are scoped to their active account; a mismatched value returns forbidden.

emailstring email

User's email address

firstNamestring

User's first name

lastNamestring

User's last name

authSubstring

Authentication subject identifier

loginstring

User's login name

statusstring

Ref.Data.USER_STATUS

lastLoginFromstring date-time

Lower bound of last login timestamp range (inclusive).

lastLoginTostring date-time

Upper bound of last login timestamp range (inclusive).

Response

Paginated list of users matching criteria

pageinteger required
sizeinteger required
totalPagesinteger required
totalElementsinteger required

Example response

{
  "content": [
    {
      "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.