Persons & Users

This is an object representing your users. You can retrieve a persons properties about their position, region, legal entity they belong to, current status, and authorization to access the TIS application via single sign on.
Custom fields and user groups associated with a person object can be retrieved as well.

Collections

curl --request GET \
     --url 'https://example.com/rest/api/bam/persons?page_number=1&page_size=50' \
     --header 'accept: application/json'

{
  "page_number": 1,
  "numberOfPages": 5,
  "page_size": 50,
  "totalNumberOfElements": 240,
  "content": [
    {
      "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "nationalId": "string",
      "citizenship": "US",
      "title": "string",
      "phoneNumber": "string",
      "position": "string",
      "status": "DEACTIVATED, NOTCONFIRMED, CONFIRMED, REJECTED",
      "retentionState": "NOT_BLOCKED, BLOCKED, UNBLOCKED",
      "tokenType": "HARDWARE, SOFTWARE",
      "tokenNumber": "string",
      "externalUserId": "string",
      "hasAccount": true,
      "ssoUser": true,
      "changeTime": "2019-08-24T14:15:22Z",
      "legalEntity": {
        "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
        "businessId": "string",
        "name": "string",
        "country": "BG",
        "changeTime": "2019-08-24T14:15:22Z",
        "region": {
          "id": "1e2e1b43-0fa0-43bc-8e15-0fca71da2edd",
          "name": "string",
          "language": "string",
          "changeTime": "2019-08-24T14:15:22Z",
          "regionalManager": {
            "firstName": "string",
            "lastName": "string",
            "email": "[email protected]"
          }
        }
      }
    }
  ]
}

Items
After you have retrieved a list of available Persons with a corresponding partner "id", you can retrieve an item by appending the "id" in the persons URI bam/persons/{personId}.

Filters
You can apply filters in the request to query based on:

status
retentionState
firstName
lastName
email
legalEntityBusinessId
legalEntityName

Custom fields and user groups associated with a person object can also be retrieved.