Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
Add or remove one or more principals to or from a group.
Availability
Breeze 4
Description
Adds one or more principals to a group, or removes one or more principals from a group.
To update multiple principals and groups, specify multiple trios of group-id, principal-id, and is-member parameters.
You can obtain a group-id by calling principal-list and filtering the response with filter-type=group or another filter value such as filter-type=admins. The built-in groups have distinctive types other than group (see type for a list of values).
Request URL
http://server_name/api/xml ?action=group-membership-update &group-id=integer &principal-id=integer &is-member=boolean &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
group-id |
BIGINT |
Y |
The ID of the group in which you want to add or change members. |
|
principal-id |
BIGINT |
Y |
The ID of the principal whose membership status you want to update. Returned by principal-info. |
|
is-member |
Boolean |
Y |
Whether the principal is added to (true) or deleted from (false) the group. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
Results cannot be filtered or sorted.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> </results>
Response values
|
Element |
Attribute |
Type |
Description |
|
results |
|
Container |
Top-level element for the response. |
|
status |
|
Empty, with attributes |
The status of the response. |
|
|
code |
Allowed value |
A code indicating the response status (see status). |
Sample request
https://example.com/api/xml?action=group-membership-update&group-id=632398 &principal-id=2006258745&is-member=true
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>
