Platform | Group
Service to manage entities of type 'Group'.
Overview
URL | api/{tenantKey}/{orgKey}/identity/groups |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET Groups (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See GroupResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Group by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See GroupResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Group by key
Returns the entity record that matches the specified key.
The following elements are required:
groupKey | (string) Group. |
Response:
When successful, the response body contains the entity record. See GroupResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST UserGroups
Creates a new entity record.
The following elements are required:
groupResource | (ApiUserGroupsResource) The request body should contain the entity record that should be created. See ApiUserGroupsResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiUserGroupsResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Add Users by keys
Adds the specified 'Users' to the 'Group' (by specifying its keys).
The following elements are required:
groupKey | (string) Group. |
value | (Array of string) A list of record keys to be added. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Add Users by identifiers
Adds the specified 'Users' to the 'Group' (by specifying its identifiers).
The following elements are required:
groupKey | (string) Group. |
value | (Array of string) A list of record identifiers to be added. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Remove Users by keys
Removes the specified 'Users' to the 'Group' (by specifying its keys).
The following elements are required:
groupKey | (string) Group. |
value | (Array of string) A list of record keys to be removed. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Remove Users by identifiers
Removes the specified 'Users' to the 'Group' (by specifying its identifiers).
The following elements are required:
groupKey | (string) Group. |
value | (Array of string) A list of record identifiers to be removed. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Email Group
Updates the value of attribute 'Email' in the specified entity record.
The following elements are required:
groupKey | (string) Group. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set GroupKey Group
Updates the value of attribute 'GroupKey' in the specified entity record.
The following elements are required:
groupKey | (string) Group. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Group
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
groupKey | (string) Group. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Name Group
Updates the value of attribute 'Name' in the specified entity record.
The following elements are required:
groupKey | (string) Group. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Notes Group
Updates the value of attribute 'Notes' in the specified entity record.
The following elements are required:
groupKey | (string) Group. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Group by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Group by key
Deletes the entity record that matches the specified key.
The following elements are required:
groupKey | (string) Group. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiUserGroupsResource
The following elements are required:
groupKey | (string) Group. |
name | (string) Name. |
The following elements are optional:
(string) Email. | |
notes | (string) Notes. |
GroupResource
The following elements are required:
groupKey | (string) Group. |
name | (string) Name. |
The following elements are optional:
(string) Email. | |
notes | (string) Notes. |
users | (User) Users. |