RemoveAccess
- GT (Unlicensed)
Note: This is only for the MTOA Platform Team.
Description
Removes a users permissions for a specific application identification number.
Package Details
Interface
IUserApplicationManagementManagerSyntax
Task RemoveAccess(int userId, int applicationId, int modifiedByUserId)Returns
voidAPI
POST - /api/v1/userapplications/{id}/removeaccess
Parameters
Parameter | Description | Type |
|---|---|---|
id | The identification number of the application (required). The application must exist. | Path |
userId | The user’s identification number (required). The user must exist. | Querystring |
modifiedByUserId | The identification number of the user who removed the access (required). The user must exist and have the permissions to remove access. | Querystring |
Returns
HTTP 200 - OK
User access has been successfully removed.
HTTP 400 - Bad Request
Error | Message | MTAPI Status Code |
|---|---|---|
Invalid user id | UserId:{userId} couldn't be found. | 4041003 |
Invalid application id | Application id:{id} couldn't be found. | 623001 |
Invalid permissions to remove the access | Remove user access failed for applicationId: {id}, userId: {id}, modifiedByUserId: {id}. | 623007 |
Remove access failed | Remove user access failed for applicationId: {id}, userId: {userId}, modifiedByUserId: {modifiedByUserId}. | 623009 |