Get Customer Users

This API is used to used to retrieve Customer related users information..

HTTP URL
GET	api/v2/customer/{id}/user/{id}

NOTE: If user {id} is not provided, retrieve all users of the specified customer and his sub customers.

TIP: Use RSQL for filtering purposes (retrieve users of a specific sub account etc.).

Eligibility

The Requester is eligible to request and receive information on own customer or sub-customers.

API Request

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content Data Objects

Element	Type	M/O/CM	Description
id	UUID	M	User universal unique identity
username	String	M	Security Management Application username. This is the valid user email address.
usertype	String	M	Type of the user. ENUM valid values: PORTAL, PUBLIC_API
customerId	UUID	M	Customer ID or sub-customer ID which the user belongs to
customerName	String	O	Customer name which the user belongs to
role	String	O	User role. ENUM valid values: ROLE_SUPER_ADMIN, ROLE_USER, ROLE_READ_ONLY, ROLE_SUPPORT, ‘ROLE_SUPER_ADMIN+IMPERSONATOR’
logoImage	String	O	User logo image (e.g., avatar)

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
CUSTOMER_1002	Customer does not exist

Examples

Request Body

Response Body: Success ACK

Response Body: Failure NAK