...
Example - Get All Groups
An example of fetching all groups.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 8E064E7A-847F-4853-AFFF-2CD1803664D7 | The ID of the user to fetch group membership for |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Id": "9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44",
"Name": "Admins",
"Description": "System Administrators",
"Self": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44",
"Links": [
{
"Title": "Members",
"Href": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44/users",
"Rel": "Users"
},
{
"Href": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44/permissions/global",
"Rel": "GlobalPermissions"
},
{
"Href": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44/permissions/projects",
"Rel": "ProjectPermissions"
}
]
},
{
"Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d",
"Name": "QA",
"Description": "QA Team (Testers + Test Managers)",
"Self": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d",
"Links": [
{
"Title": "Members",
"Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/users",
"Rel": "Users"
},
{
"Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/global",
"Rel": "GlobalPermissions"
},
{
"Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/projects",
"Rel": "ProjectPermissions"
}
]
}
]
|
Status Code
200 - OK
...
Example - Set Members
Set the groups a user belongs to.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | 8E064E7A-847F-4853-AFFF-2CD1803664D7 | The ID of the user to set groups for. |
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"Items": [
{
"Id": "9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44"
},
{
"Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d"
}
]
}
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"Id": "9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44",
"Name": "Admins",
"Description": "System Administrators",
"Self": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44",
"Links": [
{
"Title": "Members",
"Href": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44/users",
"Rel": "Users"
},
{
"Href": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44/permissions/global",
"Rel": "GlobalPermissions"
},
{
"Href": "http://localhost/api/group/9e1ee34b4109a8f4-f96f58cc-40054c91-9f7aa1db-1457df86256def01b0ccbd44/permissions/projects",
"Rel": "ProjectPermissions"
}
]
},
{
"Id": "9e1ee34b-f96f-4005-9f7a-1457df86256d",
"Name": "QA",
"Description": "QA Team (Testers + Test Managers)",
"Self": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d",
"Links": [
{
"Title": "Members",
"Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/users",
"Rel": "Users"
},
{
"Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/global",
"Rel": "GlobalPermissions"
},
{
"Href": "http://localhost/api/group/9e1ee34b-f96f-4005-9f7a-1457df86256d/permissions/projects",
"Rel": "ProjectPermissions"
}
]
}
]
|
Status Code
200 - OK
...