GetUsersByApplicationId
- Yuko Yamamoto (Unlicensed)
Note: This is only for the MTOA Platform Team.
Description
Retrieve internal users based on an application id
Package Details
Interface
IUserApplicationManagementManagerSyntax
await UserApplicationManagementManager.GetUsersByApplicationId(int appId, int? page = null, int? pageSize = null, string userName = "", string emailAddress = "", UserRoleType? userRoleType = null, int? servId = null);Returns
UserApplicationInfoResultAPI
GET - /api/v1/userapplications/{id}/users
Parameters
Parameter | Description | Type |
|---|---|---|
appId | The identification number of the application. | Path |
page | page number. Optional. If it is empty, the default value is 1 | Query string |
pageSize | size of the page. Optional. If it is empty, the default value is the MTOA max page size (100). | Query string |
userName | Optional. If it is entered, it will search users whose first name or last name that contains the value. Note: If email address and name are entered, it will search users that have the email address or the user name. | Query string |
emailAddress | Optional. If it is entered, it will search email address that contains the value. Note: If email address and name are entered, it will search users that have the email address or the user name. | Query string |
UserRoleType | Optional. User role code. If it is entered, the result will be filtered by the role. It will search users with the role. | Query string |
ServId | Optional. Service Id. If it is entered, it will be filtered by the service id. It will search users that have access to the service. | Query string |
Returns
HTTP 200 - OK
Example