The workgroup web service provides a programmatic way to perform all of the same transactions that can be done in Workgroup Manager.
This includes:
- Search for a workgroup by name
- Search for workgroups by an identifier (Certificate, Person or Workgroup Name)
- Getting the details of a workgroup
- Creating and deleting a new workgroup from an existing stem
- Updating workgroup attributes
- Getting the privgroup of a workgroup
- Getting the workgroup integrations linkage of a workgroup
- Adding and deleting members
- Adding and deleting administrators
- Adding and delete workgroup integration linkage
How to get started with the Workgroup API
Follow the Middleware and Integration Services Integration (MaIS) checklist for RESTful Web Services. If you need help, are not sure whether the Web APIs are the best method for integrating with the registry, or just have some questions, contact the MaIS team.
HTTP Status codes
| CODE | CONDITIONS | |
|---|---|---|
| 200 OK | The usual successful return code. | |
| 201 OK | The usual successful return code for a create (POST). | |
| 400 Bad Request | Missing required parameters or identifier is in wrong format. | |
| 401 Authorization Required | The request was made without certificate. | |
| 403 Access Denied | The request was made without valid certificate. | |
| 404 Not Found | The record you're looking for doesn't exist. | |
| 500 Internal Server Error | Something broke with our code. Please tell us about it. | |
Error handling
Workgroup API sends error status via standard HTTP status codes (4xx) and always returns an Json document detailing the error. For example, when a client makes a call to update a workgroup filter with no supported filter value, the system will return the following Json error document:
PUT https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:new?filter=standard
Status: 400
Content-Type: application/json
{
"notification": "Unupported FILTER value of STANDARD. Supported values are ACADEMIC_ADMINISTRATIVE, FACULTY, STAFF, STUDENT, FACULTY_STAFF, FACULTY_STUDENT, STAFF_STUDENT, FACULTY_STAFF_STUDENT, NONE",
"code": 400,
"message": "Bad Request",
"status": 400
}
Search workgroup by name
| Description | Retrieve a list of active workgroups based on {SEARCH STRING}. If no wildcards are used then it will search for an exact match of the {SEARCH STRING}. You cannot start with a wildcard. If timeout happens then increase the search string characters before the wildcard. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/search/{SEARCH STRING} | |
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/search/{SEARCH STRING} | |
| Method | GET | |
| Returns | 200 OK | |
| 401 Unauthorized | ||
GET https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/search/mais*
Status: 200
Content-Type: application/json
{
"search" : "mais:*",
"results": [
{
"name": "mais:staff",
"description": "Staff of AS/Middleware and Integration Services",
"integrations": [{ "GOOGLE": "mais-staff" },
{ "MAILING_LIST": "mais-all-staff" } ],
"lastUpdate": "22-JUL-2019",
"lastUpdateBy": "workgroup_maint",
"memberCount": "8"
}, {
"name": "workgroup:mais",
"description": "Staff of AS/Middleware and Integration Services",
"integrations": [" {"PTS": "workgroup:mais" } ],
"lastUpdate": "22-JUL-2019",
"lastUpdateBy": "workgroup_maint",
"memberCount": "8"
}, ...
]
}
Search for workgroups by an identifier (Certificate, Person or Workgroup Name)
| Description | Retrieve a list of active workgroups where the identifier of that type (Certificate, Person or Workgroup) is a member or administrator including where the identifier is nested. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0 or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0?type={CERTIFICATE | USER | WORKGROUP}&id={input value} |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0 or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0?type={CERTIFICATE | USER | WORKGROUP}&id={input value} |
|
| Method | GET | |
| Parameter Fields | type: CERTIFICATE | USER | WORKGROUP id: Identifier value |
|
| Returns | 201 Created | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 409 Conflict | ||
GET https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0
{
"type" : "WORKGROUP",
"id": "mais:staff"
}
Status: 200
Content-Type: application/json
{
"type": "WORKGROUP",
"id": "mais:staff",
"members": [
{
"name": "asview:mais-admin-prd",
"description": "Workgroup for SUNAC access to MAIS PRD env",
"integrations": [{ "MAILING_LIST": "mais-all-staff" }],
"lastUpdate": "22-JUL-2019",
"lastUpdateBy": "workgroup_maint",
"memberCount": "5"
}, {
"name": "deviceregistry:mydevices-search",
"description": "My Devices Search tab access",
"integrations": [],
"lastUpdate": "22-JUL-2019",
"lastUpdate_by": "workgroup_maint",
"memberCount": "193"
}
],
"administrators": [
{
"name": "deviceregistry:mydevices-search",
"description": "My Devices Search tab access",
"integrations": [],
"lastUpdate": "22-JUL-2019",
"lastUpdateBy": "workgroup_maint",
"memberCount": "193"
}
]
}
Get workgroup
| Description | Retrieve information on an active workgroup including integration, members and administrators | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} | |
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} | |
| Method | GET | |
| Returns | 200 OK & workgroup Json | |
| 404 Not Found | ||
If authenticated user is an administrator of the workgroup, return Json document include public (description, filter, visibility, privgroup, and reusable) and private (members and administrators) information. If authenticated user is not an administrator of the workgroup, return Json document includes only public information of the workgroup. Please note that "authenticated user" may refer to a certificate name, in which case the certificate needs to be configured as a workgroup administrator.
GET https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff
Status: 200
Content-Type: application/json
{
"name": "mais:staff",
"description": "Staff of AS/Middleware and Integration Services",
"filter": "NONE",
"visibility": "STANFORD",
"reusable": "TRUE",
"privgroup": "TRUE",
"integrations": [{ "GOOGLE": "mais-staff" },
{ "MAILING_LIST": "mais-all-staff" }],
"lastUpdate": "22-JUL-2019",
"lastUpdateBy": "workgroup_maint",
"members": [
{
"type": "PERSON",
"id": "chowhan",
"name": "Chowhan, Sangeetha"
}, {
"type": "PERSON",
"id": "hlclark",
"name": "Clark, Helen"
}, {
"type": "WORKGROUP",
"id": "workgroup:mais",
"name": "workgroup:mais"
}, {
"type": "CERTIFICATE",
"id": "www.stanford.edu",
"name": "www.stanford.edu"
} ],
"administrators" : [
{
"type": "PERSON",
"id": "smarella",
"name": "Marella, Sameer"
}, {
"type": "WORKGROUP",
"id": "workgroup:mais-owners",
"name": "workgroup:mais-owners"
} ]
}
Create workgroup
| Description | Create a new workgroup, where the name is limited to 60 characters or less and items parameters in RED are the default values | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}?{workgroup-name}?description={description}&filter={filter}&resuable={reusable}&visibility={visibility}&privgroup={privgroup} |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}?{workgroup-name}?description={description}&filter={filter}&resuable={reusable}&visibility={visibility}&privgroup={privgroup} |
|
| Method | POST | |
| Parameter Fields | description*: If the workgroup description contains more than 255 characters, only the first 255 characters are used. *Cannot be empty or blank. filter: ACADEMIC_ADMINISTRATIVE | STUDENT | FACULTY | STAFF | FACULTY_STAFF | FACULTY_STUDENT | STAFF_STUDENT | FACULTY_STAFF_STUDENT | NONE reusable: TRUE | FALSE visibility: PRIVATE | STANFORD privgroup: TRUE | FALSE |
|
| Returns | 201 Created and workgroup Json | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 409 Conflict | ||
Please note that authenticated user has to be an administrator of the workgroup, return Json document include public (description, filter, visibility, privgroup and reusable) and private (members and administrators) information. If authenticated user is not an administrator of the workgroup, return Json document includes only public information of the workgroup. Please note that "authenticated user" may refer to a certificate name, in which case the certificate needs to be configured as a workgroup administrator.
POST https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff
{
"description" : "Staff of AS/Middleware and Integration Services",
"reusable" : "TRUE",
"privgroup" : "FALSE",
}
Status: 201
Content-Type: application/json
{
"name": "mais:staff",
"description": "Staff of AS/Middleware and Integration Services",
"filter": "NONE",
"visibility": "STANFORD",
"reusable": "TRUE",
"privgroup": "FALSE",
"integrations": [],
"lastUpdate": "22-JUL-2019",
"lastUpdateBy": "workgroup_maint",
"members": [],
"administrators" : [
{
"type" : "PERSON",
"id" : "etlouie",
"name" : "Louie, Edward",
} ]
}
Update workgroup
| Description | Update information of a workgroup. The returning JSON will be the return the same information as if the user called the Get Workgroup By Name API call. You only need to specify the fields you wish to update. If no fields are passed then nothing is updated. Adding and Removing Members or Administrators or Linking and Unlinking Integration Points are not available in this API, there are separate API end points to perform those functionalities. |
|
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}?{workgroup-name}?description={description}&filter={filter}&resuable={reusable}&visibility={visibility}&privgroup={privgroup} |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}?{workgroup-name}?description={description}&filter={filter}&resuable={reusable}&visibility={visibility}&privgroup={privgroup} |
|
| Method | PUT | |
| Paramater Fields | description*: If the workgroup description contains more than 255 characters, only the first 255 characters are used. *Cannot be empty or blank. filter: ACADEMIC_ADMINISTRATIVE | STUDENT | FACULTY | STAFF | FACULTY_STAFF | FACULTY_STUDENT | STAFF_STUDENT | FACULTY_STAFF_STUDENT | NONE reusable: TRUE | FALSE visibility: PRIVATE | STANFORD privgroup: TRUE | FALSE |
|
| Returns | 200 OK and workgroup Json | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 409 Conflict | ||
Please note that authenticated user has to be an administrator of the workgroup, return Json document include public (description, filter, visibility, privgroup and reusable) and private (members and administrators) information. If authenticated user is not an administrator of the workgroup, return Json document includes only public information of the workgroup. Please note that "authenticated user" may refer to a certificate name, in which case the certificate needs to be configured as a workgroup administrator.
PUT https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff
{
"description" : "Staff of AS/Middleware and Integration Services",
"reusable" : "TRUE",
"privgroup" : "FALSE",
}
Status: 201
Content-Type: application/json
{
"name": "mais:staff",
"description": "Staff of AS/Middleware and Integration Services",
"filter": "NONE",
"visibility": "STANFORD",
"reusable": "TRUE",
"privgroup": "FALSE",
"integrations": [],
"lastUpdate": "22-JUL-2019",
"lastUpdateBy": "workgroup_maint",
"members": [],
"administrators" : [
{
"type" : "PERSON",
"id" : "etlouie",
"name" : "Louie, Edward",
} ]
}
Delete workgroup
| Description | These active workgroups are marked inactive and are retained in the system for future reference, however all members and administrators will be removed. If you try to inactivate an inactive workgroup, you'll get a 404 Not Found error. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} | |
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name} | |
| Method | DELETE | |
| Returns | 200 OK and Json | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
DELETE https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0.mais:wgapi
Status: 200
Content-Type: application/json
{
"status": "200",
"code": "200",
"message": "Deleted",
"notification": "Workgroup: mais:wgapi has been deleted and all members and administrators removed"
}
Get privilege group for a workgroup
| Description | Get Privilege Group Members from a Workgroup. By default, if no Query Parameter or JSON body is used, the API will return both MEMBERS and ADMINISTRATORS within its own key. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/privgroup or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/privgroup?role={ MEMBERS | ADMINISTRATORS} |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/privgroup or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/privgroup?role={ MEMBERS | ADMINISTRATORS} |
|
| Method | GET | |
| Parameter Fields | role: MEMBERS | ADMINISTRATORS | |
| Returns | 200 OK and workgroup Json | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
PUT https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/privgroup
{
"role": "MEMBER"
}
Status: 200
Content-Type: application/json
{
"name": "mais:staff",
"members": [
{
"name": "Louie, Edward ",
"id": "etlouie",
"lastUpdate": "22-JUL-2019"
}, {
"name": "Chowhan, Sangeetha",
"id": "chowhan",
"lastUpdate": "22-JUL-2019"
}
],
"administrators": [
{
"name": "Chowhan, Sangeetha",
"id": "chowhan",
"lastUpdate": "22-JUL-2019"
}
]
}
Add member to workgroup
| Description | Add an existing SUNet ID or workgroup to a workgroup as a member | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name} or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name}?type={ USER | WORKGROUP } |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name} or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name}?type={ USER | WORKGROUP } |
|
| Method | PUT | |
| Paramter Fields | type: USER | WORKGROUP | |
| Returns | 200 OK and Json Message | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
PUT https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/members/etlouie
{
"type": "USER"
}
Status: 200
Content-Type: application/json
{
"status": "200",
"code": "200",
"message": "Added",
"notification": "etlouie was added as a member to the workgroup: mais:staff"
}
Remove member from workgroup
| Description | Remove a member of type person or workgroup from a workgroup | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name} or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name}?type={ USER | WORKGROUP } |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name} or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/members/{sunetid | workgroup-name}?type={ USER | WORKGROUP } |
|
| Method | DELETE | |
| Parameter Fields | type: USER | WORKGROUP | |
| Returns | 200 OK and Json Message | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
Note: Deleted workgroups and memberships are marked inactive and retained in the system for future reference.
DELETE https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/members/etlouie
{
"type": "USER"
}
Status: 200
Content-Type: application/json
{
"status": "200",
"code": "200",
"message": "Removed",
"notification": "etlouie was removed as a member to the workgroup: mais:staff"
}
Add administrator to workgroup
| Description | Add an existing SUNet ID, workgroup or certificate to a workgroup as an administrator. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name} or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name}?type={ USER | WORKGROUP | CERTIFICATE } |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name} or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name}?type={ USER | WORKGROUP | CERTIFICATE } |
|
| Method | PUT | |
| Parameter Fields | type: CERTIFICATE | USER | WORKGROUP | |
| Returns | 200 OK and Json Message | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
PUT https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/administrators/etlouie
{
"type": "USER"
}
Status: 200
Content-Type: application/json
{
"status": "200",
"code": "200",
"message": "Added",
"notification": "etlouie was added as an administrator to the workgroup: mais:staff"
}
Remove administrator from workgroup
| Description | Remove an administrator of type person, workgroup or certificate from a workgroup. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name} or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name}?type={ USER | WORKGROUP | CERTIFICATE } |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name} or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/administrators/{sunetid | workgroup-name | certificate-name}?type={ USER | WORKGROUP | CERTIFICATE } |
|
| Method | DELETE | |
| Parameter Fields | type: USER | WORKGROUP | |
| Returns | 200 OK and Json Message | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
Note: Deleted workgroups and memberships are marked inactive and retained in the system for future reference.
DELETE https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/administrators/etlouie
{
"type": "USER"
}
Status: 200
Content-Type: application/json
{
"status": "200",
"code": "200",
"message": "Removed",
"notification": "etlouie was removed as an administrator to the workgroup: mais:staff"
}
Get integration of a workgroup
| Description | Show only the integration link of a workgroup | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links | |
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links | |
| Method | GET | |
| Returns | 200 OK and Json Message | |
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
GET https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/links
Status: 200
Content-Type: application/json
{
"name" : "mais:staff",
"integrations": [{ "OFFICE365": "mais-staff" },
{ "MAILING_LIST": "mais-all-staff" }]
}
Add link integration to a workgroup
| Description | Add an integration link to a Workgroup. Using parameter Link require a secondary parameter Value for Mailing List and PTS. All the other values are defaulted to the workgroup name which cannot be changed. Google currently has a 60 character limit so if you cannot create a link then the reason is that the workgroup could be greater than the allowed integration character length. The resulting JSON will return back the name of the workgroup and the current Integration Links of that workgroup. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links?link={ GOOGLE | MAILING_LIST | OFFICE365 | PTS | WIN_DIRECTORY }&value={input value} |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links?link={ GOOGLE | MAILING_LIST | OFFICE365 | PTS | WIN_DIRECTORY }&value={input value} |
|
| Method | PUT | |
| Parameter Fields | link: GOOGLE | MAILING_LIST | OFFICE365 | PTS | WIN_DIRECTORY | |
| Returns | 200 OK and Json Message | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
PUT https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/links
{
"link": "MAILING_LIST",
"value": "mymailinglist"
}
Status: 200
Content-Type: application/json
{
"name" : "mais:staff",
"integrations": [{ "OFFICE365": "mais-staff" },
{ "MAILING_LIST": "mais-all-staff" }]
}
Remove link integration from a workgroup
| Description | Remove an integration link from a Workgroup. The resulting JSON will return back the name of the workgroup and the current Integration Links of that workgroup, if any. | |
|---|---|---|
| URL | https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links or https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links?link={ BOX | GOOGLE | MAILING_LIST | OFFICE365 | PTS | WIN_DIRECTORY } |
|
| UAT URL | https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links or https://aswsuat.stanford.edu/mais/workgroupsvc/workgroups/2.0/{workgroup-name}/links?link={ BOX | GOOGLE | MAILING_LIST | OFFICE365 | PTS | WIN_DIRECTORY } |
|
| Method | DELETE | |
| Parameter Fields | link: GOOGLE | MAILING_LIST | OFFICE365 | PTS | WIN_DIRECTORY | |
| Returns | 200 OK and Json Message | |
| 400 Bad Request | ||
| 401 Unauthorized | ||
| 404 Not Found | ||
Only workgroup administrators are allowed to operate on a workgroup. Please note that the certificate used to authenticate with the API needs to be configured as a workgroup administrator.
DELETE https://aswsweb.stanford.edu/mais/workgroupsvc/workgroups/2.0/mais:staff/links
{
"link": "MAILING_LIST",
}
Status: 200
Content-Type: application/json
{
"name" : "mais:staff",
"integrations": [{ "OFFICE365": "mais-staff" } ]
}
