Search for End User(s) in a Tenant

List users

GET /api/v1/tenants/(string: tenant_id)/search/users/

List all the end users of a Tenant matching some filter criteria.

Several criteria can be used in hte same request (AND mode), but each criterium can only be used once on a request.

Example request:

GET /api/v1/tenants/foo/search/users/ HTTP/1.1
Host: example.com

{
   "sensitiveUserLastNameStarts": "Test"
}

Request JSON Object:

• sensitiveUserIdStarts (string) – See sensitiveUserIdStarts from Search criteria.

• sensitiveUserIdContains (string) – See sensitiveUserIdContains from Search criteria.

• sensitiveUserIdEquals (string) – See sensitiveUserIdEquals from Search criteria.

• insensitiveUserIdStarts (string) – See insensitiveUserIdStarts from Search criteria.

• insensitiveUserIdContains (string) – See insensitiveUserIdContains from Search criteria.

• insensitiveUserIdEquals (string) – See insensitiveUserIdEquals from Search criteria.

• sensitiveUserLastNameStarts (string) – See sensitiveUserLastNameStarts from Search criteria.

• sensitiveUserLastNameContains (string) – See sensitiveUserLastNameContains from Search criteria.

• sensitiveUserLastNameEquals (string) – See sensitiveUserLastNameEquals from Search criteria.

• insensitiveUserLastNameStarts (string) – See insensitiveUserLastNameStarts from Search criteria.

• insensitiveUserLastNameContains (string) – See insensitiveUserLastNameContains from Search criteria.

• insensitiveUserLastNameEquals (string) – See insensitiveUserLastNameEquals from Search criteria.

• sensitiveUserFirstNameStarts (string) – See sensitiveUserFirstNameStarts from Search criteria.

• sensitiveUserFirstNameContains (string) – See sensitiveUserFirstNameContains from Search criteria.

• sensitiveUserFirstNameEquals (string) – See sensitiveUserFirstNameEquals from Search criteria.

• insensitiveUserFirstNameStarts (string) – See insensitiveUserFirstNameStarts from Search criteria.

• insensitiveUserFirstNameContains (string) – See insensitiveUserFirstNameContains from Search criteria.

• insensitiveUserFirstNameEquals (string) – See insensitiveUserFirstNameEquals from Search criteria.

• insensitivePhoneNumberStarts (string) – See insensitivePhoneNumberStarts from Search criteria.

• insensitivePhoneNumberContains (string) – See insensitivePhoneNumberContains from Search criteria.

• insensitivePhoneNumberEquals (string) – See insensitivePhoneNumberEquals from Search criteria.

• sensitiveEmailAddressStarts (string) – See sensitiveEmailAddressStarts from Search criteria.

• sensitiveEmailAddressContains (string) – See sensitiveEmailAddressContains from Search criteria.

• sensitiveEmailAddressEquals (string) – See sensitiveEmailAddressEquals from Search criteria.

• insensitiveEmailAddressStarts (string) – See insensitiveEmailAddressStarts from Search criteria.

• insensitiveEmailAddressContains (string) – See insensitiveEmailAddressContains from Search criteria.

• insensitiveEmailAddressEquals (string) – See insensitiveEmailAddressEquals from Search criteria.

• insensitiveExtensionStarts (string) – See insensitiveExtensionStarts from Search criteria.

• insensitiveExtensionContains (string) – See insensitiveExtensionContains from Search criteria.

• insensitiveExtensionEquals (string) – See insensitiveExtensionEquals from Search criteria.

• insensitiveUserInTrunkGroupEquals (string) – See insensitiveUserInTrunkGroupEquals from Search criteria.

• responseSizeLimit (integer) – See responseSizeLimit from Search criteria.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "users": [
      {"userId": "user1@netaxis.be", "firstName": "tom", "lastName": "smith", "extension": "1234", "emailAddress": "", "phoneNumber": "+3225126777", "inTrunkGroup": false, "groupId" : "FooGroup"},
      {"userId": "user2@sip.netaxis.be", "firstName": "john", "lastName": "doe", "extension": "4321", "emailAddress": "", "department": {"tenantId": "ApioSpTest", "groupId": "ApioGrpTest", "departmentName": "test_department_initial", "fullPathName": "test_department_parent_1 \\ test_department_initial"}, "phoneNumber": "+3225125757", "inTrunkGroup": false, "groupId" : "FooExample"}
   ]
}

Response JSON Object:

• users (array) – a list of user objects as defined as User in List attributes.

Status Codes:

• 200 OK – no error

Configuration Information for the User Ids in the List answer

The APIO will add the AS System Default Domain to be User Ids in the answer of the List API or not depending on the following setting:

DISPLAY_USER_ID_WITH_SYSTEM_DEFAULT_DOMAIN": true

Settings description:

• DISPLAY_USER_ID_WITH_SYSTEM_DEFAULT_DOMAIN: (Boolean) Adapt the OCI answers. Default is true.

This has been introduced in release 1.10.3.