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)
Create a group
Create a group with the specified name. Caller requires the GROUPS:ADD permission.
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
deleteGroupUsingDELETE(id)
Remove a group
Remove the specified group. Caller requires the GROUPS:REMOVE permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | The UUID of the group to be removed. |
Return type
null (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)
Get a group by externalId
Get the specified group by externalId. Caller requires the GROUPS:VIEW permission.
Example
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(id)
Get a group
Get the specified group. Caller requires the GROUPS:VIEW permission.
Example
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)
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
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
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
modifyUserAuthorizationGroupAssociationsUsingPUT(userid, requestBody)
Modify user group membership
Modify the list of groups assigned to a specified user. Caller requires the USERS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose group membership is to be modified. | |
| requestBody | List<String> |
Return type
null (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(id, groupParms)
Update a group
Update the specified group. Caller requires the GROUPS:EDIT permission.
Example
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 | - |