GroupsApi
| Method | HTTP request | Description |
|---|---|---|
| CreateGroupUsingPOST | POST /api/web/v1/groups | Create a group |
| DeleteGroupUsingDELETE | DELETE /api/web/v1/groups/{id} | Remove a group |
| GroupByExternalIdUsingPOST | POST /api/web/v1/groups/externalid | Get a group by externalId |
| GroupUsingGET | GET /api/web/v1/groups/{id} | Get a group |
| GroupsPagedUsingPOST | POST /api/web/v1/groupspaged | List a page of groups |
| GroupsUsingGET | GET /api/web/v1/groups | List groups |
| ModifyUserAuthorizationGroupAssociationsUsingPUT | PUT /api/web/v1/userauthorizationgroup/{userid}/groups | Modify user group membership |
| UpdateGroupUsingPUT | PUT /api/web/v1/groups/{id} | Update a group |
CreateGroupUsingPOST
Group CreateGroupUsingPOST (GroupParms groupParms)
Create a group
Create a group with the specified name. Caller requires the GROUPS:ADD permission.
Using the CreateGroupUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupParms | GroupParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
DeleteGroupUsingDELETE
void DeleteGroupUsingDELETE (string id)
Remove a group
Remove the specified group. Caller requires the GROUPS:REMOVE permission.
Example
Using the DeleteGroupUsingDELETEWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the group to be removed. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GroupByExternalIdUsingPOST
Group GroupByExternalIdUsingPOST (GroupId groupId)
Get a group by externalId
Get the specified group by externalId. Caller requires the GROUPS:VIEW permission.
Example
Using the GroupByExternalIdUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | GroupId |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GroupUsingGET
Group GroupUsingGET (string id)
Get a group
Get the specified group. Caller requires the GROUPS:VIEW permission.
Example
Using the GroupUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the group to fetch. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GroupsPagedUsingPOST
GroupsPage GroupsPagedUsingPOST (SearchParms searchParms)
List a page of groups
Returns groups for the provided search parameters. Caller requires the GROUPS:VIEW permission. The following searchByAttributes are supported:
- name: a string value that indicates the name of the group. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
- type: a string with the value that indicates the type of the group. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.
The orderByAttribute supports this attribute name: name.
Example
Using the GroupsPagedUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| searchParms | SearchParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
GroupsUsingGET
List<Group> GroupsUsingGET ()
List groups
List all groups. Caller requires the GROUPS:VIEW permission.
Example
Using the GroupsUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
ModifyUserAuthorizationGroupAssociationsUsingPUT
void ModifyUserAuthorizationGroupAssociationsUsingPUT (string userid, List<string> requestBody)
Modify user group membership
Modify the list of groups assigned to a specified user. Caller requires the USERS:EDIT permission.
Example
Using the ModifyUserAuthorizationGroupAssociationsUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | string | The UUID of the user whose group membership is to be modified. | |
| requestBody | List<string> |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
UpdateGroupUsingPUT
Group UpdateGroupUsingPUT (string id, GroupParms groupParms)
Update a group
Update the specified group. Caller requires the GROUPS:EDIT permission.
Example
Using the UpdateGroupUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the group to update. | |
| groupParms | GroupParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |