Users associated with an Entity.

get https://gateway-am.apps.ins.inswhub.com/entities/1.2/entities/{entityId}/users

Returns all users associated with the Entity identified by entityId.

Path Params

entityId

string

required

Unique ID of the Entity.

Headers

X-Date

date-time

Header parameter that informs the date and time when the message was originated. It is used for basic message integrity checks, to ensure that the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.

X-CorrelationID

string

Header parameter to uniquely identifies the request. Must be supplied as an UUID.

X-Channel

string

length ≤ 256

String containing the channel used to originate the request. For example USSD, Web, App.

X-API-Key

string

It is used to send the pre-shared client API key to the server.

X-User-Bearer

string

required

It is used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

X-Callback-URL

uri

URL supplied by the client that will be used to return the callback in the form of an HTTP PUT.

Responses

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://gateway-am.apps.ins.inswhub.com/entities/1.2/entities//users \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Users are returned without the password value.

401An unauthorized execution attemp was detected.

403The received token does not contain any of the required roles.

404There is no resource matching the requested ID or reference.