Skip to main content
Skip table of contents

6.14 Service to Manage Users in Groups

Note: available in Thru File Sharing version 9.10.8 and later.

6.14.1 GET UserGroups

List all groups in the site

Url

[ThruWebServer]/REST/[version]/UserGroups

Verb

GET

Required HTTP Headers

Accept: (application/xml or application/json)

Description

List all groups in the site

Request Body

None

Return Data Object

ThruCollectionResult<ThruPublicGroupInfo>

Invocation Scenario(s)

 

Remarks

 

6.14.2 PUT UserGroup

Update group data by a  group ID

Url

[ThruWebServer]/REST/[version]/UserGroups/[groupId]

Verb

PUT

Required HTTP Headers

Accept: (application/xml or application/json)

Description

Update group data by a  group ID

Request Body

ThruPublicGroupInfo,

Return Data Object

None

Invocation Scenario(s)

 

Remarks

GroupID is required in 2 places: on the URL and in the object ThruPublicGroupInfo. GroupID  value on URL is  used, the value in ThruPublicGroupInfo is ignored.

6.14.3 DELETE User

Delete user from a User Group  using UserID and UserGroupID

Url

[ThruWebServer]/REST/[version]/UserGroups/[groupId]/Users/[userId]

Verb

DELETE

Required HTTP Headers

Accept: (application/xml or application/json)

Description

Delete user from a User Group  using UserID and UserGroupID

Request Body

None required

Return Data Object

none

Invocation Scenario(s)

 

Remarks

Rest API version : 1.0

6.14.4 POST User

Add User to UserGroup using UserID and UserGroupID

Url

[ThruWebServer]/REST/[version]/UserGroups/[groupId]/Users/[userId]

Verb

POST

Required HTTP Headers

Accept: (application/xml or application/json)

Description

Add User to UserGroup using UserID and UserGroupID

Request Body

None

Return Data Object

None

Invocation Scenario(s)

 

Remarks

Rest API version : 1.0

6.14.5 GET Users

List users in a User Group by userGroupID

Url

[ThruWebServer]/REST/[version]/UserGroups/[groupId]/Users

Verb

GET

Required HTTP Headers

Accept: (application/xml or application/json)

Description

List users in a User Group by userGroupID

Request Body

None required

Return Data Object

ThruCollectionResult<ThruPublicUserInfo>

Invocation Scenario(s)

 

Remarks

Rest API version : 1.0

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.