Name
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 9
report-bulk-users API to get information of only users in an account and not groups.
Availability
Breeze 5
Description
Returns information about all users in an account. The difference between this call and principal-list is that principal-list returns both users and groups, while report-bulk-users returns only users.
The response from report-bulk-users can be quite large, especially if you use custom fields, so remember that you can filter and sort it. For example, the following call returns a list of all users who have the letters Jo in their name, in ascending order by name:
http://myserver.com/api/xml?action=report-bulk-users&sort-name=asc &filter-like-name=Jo
If you pass custom-fields=true, by default report-bulk-users returns up to eight custom fields defined for users. If you have defined more than eight custom fields for users, report-bulk-users returns the first eight in the list in the Customize User Profile screen in Connect Central (at Administration > Users and Groups > Customize User Profile).
If you use Adobe Connect Server, you can set a value for REPORT_MAX_CUSTOM_FIELDS in the custom.ini file to have report-bulk-users return more than eight custom fields. You can use any value, but higher values risk a greater impact to database performance. You cannot change this setting on a Adobe Connect hosted account.
Request URL
http://server_name/api/xml ?action=report-bulk-users &custom-fields=boolean &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
custom-fields |
Boolean |
N |
Whether to return custom fields in the response. Returns up to eight custom fields. If true, the manager field is not returned in the response. |
|
filter-definition |
Filter definition |
N |
A filter to reduce the volume of the response. |
|
sort-definition |
Sort definition |
N |
A sort to return results in a certain sequence. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
You can filter or sort the response on any element or attribute it contains.
You can use filter-type with report-bulk-users to filter the type of users returned (user or guest).
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <report-bulk-users> <row principal-id=integer type="string"> <login>string</login> <name>string</name> <email>string</email> <manager>string</manager> .. any custom fields .. </row> ... </report-bulk-users> </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). |
|
| report-bulk-users | Container |
The entire list of users in the account. |
|
| row | Container |
Details about one user in the account. |
|
| principal-id | BIGINT |
The ID of the user. |
|
| type | String |
The type of user, either user or guest. |
|
| login | String |
The user’s login ID, often an e-mail address. |
|
| name | String |
The full name of the user, concatenated from the user’s first name and last name. |
|
String |
The user’s e-mail address. |
||
| manager | String |
The user’s manager, also a registered user. Returned if a manager has been set for the user. Not returned if custom-fields is true in the request. |
Sample request
https://example.com/api/xml?action=report-bulk-users&filter-like-name=john
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <report-bulk-users> <row principal-id="5417288" type="guest"> <login>john@example.com</login> <name>John Owens</name> <email>john@example.com</email> </row> <row principal-id="5417255" type="user"> <login>jsmith@example.com</login> <name>John Smith</name> <email>jsmith@example.com</email> </row> ... </report-bulk-users> </results>
See also
