GroupUsers
GroupUsers
GetUsersInGroup
Returns users in the group by identifier
Request
GET /api/manage/v1/Groups/{id}/Users[?skip&take]
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Identifier of group |
|
skip | integer | 0 | how many to skip |
take | integer | 10 | how many to take |
Responses
Status Code | Description | Samples |
---|---|---|
200 | Succesfully retured |
|
400 | The reqeust is wrong |
|
403 | You don't have rights for the operation |
|
404 | Group with this identifier is not found |
|
500 | Exception thrown |
AddUserToGroup
Add user to the group by identifier
Request
PUT /api/manage/v1/Groups/{id}/Users/{userId}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Identifier of group |
|
*userId | string | Identifier of user |
Responses
Status Code | Description | Samples |
---|---|---|
200 | Succesfully retured |
|
400 | The reqeust is wrong |
|
403 | You don't have rights for the operation |
|
402 | subscription is outdated |
|
404 | Group with this identifier is not found |
|
500 | Exception thrown |
RemoveFromGroup
Remove user from the group by identifier
Request
DELETE /api/manage/v1/Groups/{id}/Users/{userId}
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Identifier of group |
|
*userId | string | Identifier of user |
Responses
Status Code | Description | Samples |
---|---|---|
204 | Succesfully removed |
|
400 | The reqeust is wrong |
|
403 | You don't have rights for the operation |
|
402 | subscription is outdated |
|
404 | Group with this identifier is not found |
|
500 | Exception thrown |
LeaveFromGroup
Leave from the group
Request
DELETE /api/manage/v1/Groups/{id}/leave
Parameters
Name | Type | Value | Notes |
---|---|---|---|
*id | string | Identifier of group |
Responses
Status Code | Description | Samples |
---|---|---|
204 | Succesfully removed |
|
400 | The reqeust is wrong |
|
402 | subscription is outdated |
|
404 | Group with this identifier is not found |
|
500 | Exception thrown |