Groups
Groups
GetPermissions
Gets group permissions by identifier
Request
GET /api/manage/v1/Groups/{id}/permissionsParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | Identifier of group |
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 |
UpdatePermissions
Update permissions
Request
POST /api/manage/v1/Groups/{id}/permissionsParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | ||
| permissionsVM |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 402 | Client Error |
|
| 403 | Forbidden |
|
| 404 | Not Found |
|
| 500 | Server Error |
GetGroup
Gets group by identifier
Request
GET /api/manage/v1/Groups/{id}Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | Identifier of group |
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 |
DeleteGroup
Delete group by identifier
Request
DELETE /api/manage/v1/Groups/{id}Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | Identifier of group |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 204 | Succesfully delete |
|
| 400 | The reqeust is wrong |
|
| 403 | You don't have rights for the operation |
|
| 402 | subscripiton is outdated |
|
| 404 | Group with this identifier is not found |
|
| 500 | Exception thrown |
GetGroupList
Gets list of user groups
Request
GET /api/manage/v1/Groups[?skip&take]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| skip | integer | 0 | How many groups need to skip |
| take | integer | 10 | How many groups need 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 | Current user is not found |
CreateGroup
Create a new user group
Request
POST /api/manage/v1/GroupsParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| viewModel | Model for creating |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Succesfully created |
|
| 400 | The reqeust is wrong |
|
| 403 | You don't have rights for the operation |
|
| 402 | subscription is outdated |
|
| 404 | Information from view model is not found |
RenameGroup
Rename group by identifier
Request
PUT /api/manage/v1/Groups/{id}/renameParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *id | string | Identifier of group |
|
| *viewModel | Model for renaming |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Succesfully renamed |
|
| 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 |