Get Users

GET /users
Bearer auth

This API call is used to retrieve users.

This API call can be executed with or without parameters. When called without any parameters, it will return all users. However, you can also include a searchText parameter to limit the response to a specific subset of users.

Note: If your system has a large number of users, it is recommended to include the page and size parameters in your API call for efficient pagination and retrieval of user data. This allows you to retrieve users in smaller, manageable batches.

Deactivated Users

Deactivated users will be returned from this call.

  • requests with the filter parameter active=true will exclude deactivated users from the response.

Query parameters

  • searchText string

    Find users whose username, first name, or last name begins with the specified searchText value.

  • active string

    Filter users by their activation status. Use "true" to return active users and "false" to return deactivated users.

  • lockedOut string

    Filter users based on their locked-out status. Use "true" to return locked-out users and "false" to return users who are not locked out.

  • page integer

    The page number, starting from 1, used in combination with the "size" parameter to retrieve results in a paginated format.

  • size integer

    The number of records to include in each page of results.

  • include string

    Specify additional information to include for the user. Options are "lastlogin" or "activities".

    Values are lastlogin or activities.

Responses

GET /users 
curl \
 --request GET 'https://localhost:8080/users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
[
  {
    "id": "f1666d0e-b1ff-4367-b678-ca711623715c",
    "name": {
      "lastName": "User",
      "firstName": "Test",
      "middleName": "A",
      "displayName": "Test User1"
    },
    "email": "testuser1@localhost.local",
    "match": {
      "disabled": false,
      "sectorIds": [
        1,
        2,
        3
      ],
      "accessAllSectors": true,
      "accessAllAccounts": false,
      "securityProfileId": 1,
      "operationalStructureIds": [
        10,
        11,
        12
      ]
    },
    "roles": [
      {
        "type": "Close",
        "value": "CloseAdmin"
      },
      {
        "type": "Certification",
        "value": "Reconciler"
      },
      {
        "type": "JournalEntry",
        "value": "Preparer"
      }
    ],
    "active": true,
    "userName": "testuser1",
    "lockedOut": false,
    "locationId": "Americas",
    "userAccess": {
      "r2RAdmin": false,
      "r2REnabled": true,
      "accessClose": true,
      "r2RReadOnly": true,
      "accessComplete": false,
      "accessAutomation": false,
      "accessCompliance": true,
      "accessCertification": true,
      "accessOperationalMatching": false
    },
    "createdDate": "2023-06-20T18:22:57Z",
    "phoneNumber": "555-555-5555",
    "departmentId": "SALES",
    "programAdminRoleId": "Admin"
  },
  {
    "id": "b8c7fd11-10b5-454d-93a4-c854fcdaae81",
    "name": {
      "lastName": "User2",
      "firstName": "Test",
      "middleName": "A",
      "displayName": "Test User2"
    },
    "email": "testuser2@localhost.local",
    "match": {
      "disabled": false,
      "sectorIds": [
        4
      ],
      "accessAllSectors": true,
      "accessAllAccounts": false,
      "securityProfileId": 2,
      "operationalStructureIds": [
        14
      ]
    },
    "roles": [],
    "active": true,
    "userName": "testuser2",
    "lockedOut": false,
    "locationId": "",
    "userAccess": {
      "r2RAdmin": false,
      "r2REnabled": false,
      "accessClose": false,
      "r2RReadOnly": false,
      "accessComplete": false,
      "accessAutomation": false,
      "accessCompliance": false,
      "accessCertification": false,
      "accessOperationalMatching": false
    },
    "createdDate": "2023-06-20T18:22:58Z",
    "phoneNumber": "",
    "departmentId": "",
    "programAdminRoleId": "Admin"
  }
]
Response examples (401) 
{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}