List Users

GET https://{{axpAPIDomain}}/api/admin/user/v1/accounts/:accountId/jobs/:jobId/users?pageNumber=2&pageSize=5

This API requires the Account Administrator role.

Lists the Users added, updated, or deleted by a job based on the criteria provided.

This includes basic details of each user and current status.

Default ordering is by loginId, unless specified otherwise via orderBy.

Request Params

Any value like 5, 10, 15, 20, 25, 30 is allowed.

Values that exceed the maximum will result in a 400 Bad Request being returned. | | filter | string | | Specifies details of a row filter.

The possible fields you can filter on are:

• firstName
• lastName
• loginId
• status

The allowed format:

• Begins with the column name to be filtered, followed by a colon, then:
  • Either an exact string to match, or
  • A string expression including the * wildcard character
    • :{PREFIX}* will be used to find out word start with.
    • :*{POSTFIX} will be used to find out word end with
    • : will be used to match exact word
  • Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string) | | orderBy | string | | Field name on which sorting needs to be performed. The default sorting order is ascending.

The possible fields that can be ordered on are:

• firstName
• lastName
• loginId

Field Names are case-sensitive (should be written as it is in description).

To specify descending order, a suffix " desc" should be added. For example, "firstName" for ascending or "firstName desc" for descending". |

HEADERS

RESPONSES

status: OK

{"pagination":{"pageNumber":2,"pageSize":10,"total":45},"users":[{"loginId":"something@domain.com","userId":"c8c2909d-75e9-484a-94c0-b7e8d30771ee","operation":"ADD","status":"COMPLETED","message":"User successfully added"},{"loginId":"steves@domain.com","userId":"c7c2909d-75e9-484a-94c0-b7e8d30772dd","operation":"ADD","status":"IN_PROGRESS","message":"Operation is in progress"},{"loginId":"steven@domain.com","userId":"b7c2909d-75e9-484a-94c0-b7e8d30771cc","operation":"ADD","status":"FAILED","message":"Invalid member of group provided"}],"links":{"prev":"/api/admin/user/api/admin/user/v1/accounts/{{accountId}}/jobs/importUserList1/users?pageNumber=1\u0026pageSize=10","next":"/api/admin/user/api/admin/user/v1/accounts/{{accountId}}/jobs/importUserList1/users?pageNumber=3\u0026pageSize=10"}}