Team Details
This is the request for details of a team. In addition to the list command, administrative users receive the list of admin and member users in this team. Existing teams can be updated here.
GET /api/cowork/admin/teams/<teamID>
Returns the details of the given team, denoted by the teamID.
{ "id": "<ID of the team>", "displayName": "<Name of the team>", "adminGroupIDs": [ "<GUID>", ... ], "adminUserIDs": [ "<GUID>", ... ], "memberGroupIDs": [ "<GUID>", ... ], "memberUserIDs": [ "<GUID>", ... ] }
| RESPONSE Fields | Value Type | Description |
|---|---|---|
| id | String | The GUID of the team, used for details and further operations |
| displayName | String | The display name value of the team, as displayed in the interface |
| adminGroupIDs | List of Strings | The list of group IDs derived from the Users and Groups manager to allow administrative access to this team for |
| adminUserIDs | List of Strings | The list of user IDs derived from the Users and Groups manager to allow administrative access to this team for |
| memberGroupIDs | List of Strings | The list of group IDs derived from the Users and Groups manager to allow read access to the team for. Only user in these groups will be able to join channels in this team |
| memberUserIDs | List of Strings | The list of user IDs derived from the Users and Groups manager to allow read access to the team for. Only these user will be able to join channels in this team. |
Example Request
# Request # Use user:password for authorization GET /api/cowork/admin/teams/3n1ytbwme7ngfyn9g9guwwurt HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK { "id": "3n1ytbwme7ngfyn9g9guwwurt", "displayName": "First Team", "adminGroupIDs": [], "adminUserIDs": [], "memberGroupIDs": [], "memberUserIDs": [] }
POST /api/cowork/admin/team/<teamID> and PUT /api/cowork/admin/team/<teamID>
Update the given team with new information.
Note: updating a team requires administrative access using the context /api/cowork/admin/team/<teamID>.
{ "displayName": "<Name of the team>", "adminGroupIDs": [ "<GUID>", ... ], "adminUserIDs": [ "<GUID>", ... ], "memberGroupIDs": [ "<GUID>", ... ], "memberUserIDs": [ "<GUID>", ... ] }
| REQUEST Fields | Value Type | Description |
|---|---|---|
| displayName | String | The display name value of the channel, as displayed in the interface |
| adminGroupIDs | List of Strings | Optional list of group IDs derived from the Users and Groups manager to allow administrative access to this team for |
| adminUserIDs | List of Strings | Optional list of user IDs derived from the Users and Groups manager to allow administrative access to this team for |
| memberGroupIDs | List of Strings | Optional list of group IDs derived from the Users and Groups manager to allow read access to the team for. Only user in these groups will be able to join channels in this team |
| memberUserIDs | List of Strings | Optional list of user IDs derived from the Users and Groups manager to allow read access to the team for. Only these user will be able to join channels in this team. |
Note: Updating a team requires the /api/cowork/admin context.
Note: A team without member groups or member users is an open team and every user with the CoWork permissions can join open channels in the team.
Example Request
# Request # Use user:password for authorization POST /api/cowork/admin/teams/3n1ytbwme7ngfyn9g9guwwurt HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u {"displayName":"Third Team","adminUserIDs":["truwwug9g9nyfgn7emwbty1n3"]} # Response HTTP/1.1 200 OK { "id": "3n1ytbwme7ngfyn9g9guwwurt", "displayName": "Third Team", "adminGroupIDs": [], "adminUserIDs": ["truwwug9g9nyfgn7emwbty1n3"], "memberGroupIDs": [], "memberUserIDs": [] }
Note: The request has to contain a fully configured team. If, e.g. adding an admin user, you have to send the list of previous admin users, as well as all other configured fields or they will be saved with empty values - effectively creating an open team.
DELETE /api/cowork/admin/team/<teamID>
Removes a team from CoWork if admin access is available. The response will be a 204 status on success with no additional response data.
Example Request
# Request # Use user:password for authorization DELETE /api/cowork/admin/teams/3n1ytbwme7ngfyn9g9guwwurt HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 204 OK
© Copyright 1996 - 2024, i-net software GmbH; All rights Reserved. Imprint
