Name
Last updated on
May 15, 2021
How to programmatically provide users access to or remove access from various Adobe Connect sessions.
Availability
Breeze 4
Description
Updates the permissions a principal has to access a SCO, using a trio of principal-id, acl-id, and permission-id. To update permissions for multiple principals or objects, specify multiple trios. You can update more than 200 permissions in a single call to permissions-update.
Call permissions-update to give a user access to a Adobe Connect meeting, course, curriculum, or other SCO. For example, you can use permissions-update to:
Invite a user to a meeting as participant, presenter, or host (with a permission-id of view, mini-host, or host, respectively)
Remove a user’s participant, presenter, or host access to a meeting (with a permission-id of remove)
Enroll users in courses (with a permission-id of view)
If you use multiple trios and any of them have invalid information (for example, an incorrect acl-id or principal-id), permissions-update returns an ok status, the correct trios execute, and the invalid ones do not.
Request URL
http://server_name/api/xml ?action=permissions-update &acl-id=integer &principal-id=integer &permission-id=allowedValue &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
acl-id |
BIGINT |
Y |
The ID of a SCO (a sco-id) for which you want to update permissions. |
|
principal-id |
BIGINT |
Y |
The ID of a principal, either a user or group. |
|
permission-id |
String |
Y |
The permission to assign (see permission-id for values). |
|
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=code /> </results>
Response values
|
Element |
Attribute |
Type |
Description |
|
results |
|
Container |
All results the action returns. |
|
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=permissions-update&acl-id=2006334033 &principal-id=2006258745&permission-id=host
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>
See also
permissions‑info, permissions-reset
