GroupResource

The following resources are part of this group:

/groups/{group}

The following operations are supported on this resource:

GET

Return a specific user group.

Successful Response Content

  1. group

HTTP Status code: OK - 200

Failure Response Content

  1. fault

HTTP Status code: error status code

Parameters

name description type default
group user group to retrieve path

Response Body

element: (custom)

Return a specific user group or a fault document.

DELETE

Deletes a specific user group.

Successful Response Content: No Content

HTTP Status code: No Content - 204

Failure Response Content

  1. fault

HTTP Status code: error status code

Parameters

name description type default
group user group to delete path
backup flag to indicate if the files should be backed up query true

Response Body

element: (custom)

Return no content or a fault document.

POST

Update an existing user group.

Successful Response Content

  1. group

HTTP Status code: OK - 200

Failure Response Content

  1. fault

HTTP Status code: error status code

Parameters

name description type default
group user group to update path

Request Body

element: group

Existing user group to update

Response Body

element: (custom)

Updated user group or a fault document.

/groups/{group}/users

POST

Update the users associated with an existing user group.
Note: Only the user list will be modified with this REST service

Successful Response Content

  1. group

HTTP Status code: OK - 200

Failure Response Content

  1. fault

HTTP Status code: error status code

Parameters

name description type default
group user group to update with the new list of user associations path

Request Body

element: group

Existing user group to update

Response Body

element: (custom)

Updated user group or a fault document.