Jasmin Developers - Web API Reference

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:

All Resources

This service uses the following resources:

GET Operations

GET Groups

Returns the list of all the entity records available.

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 /identity/groups

GET Groups (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page (int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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 /identity/groups?page={page}&pageSize={pageSize}

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 /identity/groups/{id}

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:

GET /identity/groups/{groupKey}

GET Print Group by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /identity/groups/{id}/print?template={template}

GET Print Group by key

Prints the specified entity record.

The following elements are required:

groupKey (string) Group.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /identity/groups/{groupKey}/print

GET Original Print GroupOriginal by identifier

Prints the specified entity record.

The following elements are required:

id (string) The record identifier.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200 OK. The operation was completed successfully.
404 NotFound. The specified resord does not exist.

Resource URL:

GET /identity/groups/{id}/printOriginal?template={template}

GET Original Print Group by key

Prints the specified entity record.

The following elements are required:

groupKey (string) Group.

The following elements are optional:

template (string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 /identity/groups/{groupKey}/printOriginal

POST Operations

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 /identity/groups

PUT Operations

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 /identity/groups/{groupKey}/email

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 /identity/groups/{groupKey}/groupKey

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 /identity/groups/{groupKey}/isActive

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 /identity/groups/{groupKey}/name

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:

PUT /identity/groups/{groupKey}/notes

DELETE Operations

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 /identity/groups/{id}

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:

DELETE /identity/groups/{groupKey}

Resources


ApiUserGroupsResource

The following elements are required:

groupKey (string) Group.
name (string) Name.

The following elements are optional:

email (string) Email.
notes (string) Notes.


GroupResource

The following elements are required:

groupKey (string) Group.
name (string) Name.

The following elements are optional:

email (string) Email.
notes (string) Notes.
users (User) Users.