List principals or guests

A principal with a type of user is a registered Connect Enterprise user, while a user with a type of guest has entered a meeting room as a guest. The server captures information about the guest and gives the guest a principal-id.

List all principals on the server

  1. Call principal-list with no parameters:
    https://example.com/api/xml?action=principal-list
    

    This call returns all Connect Enterprise users, so be prepared for a large response.

  2. Parse the principal elements in the response for the values you want:
    <principal principal-id="2006282569" account-id="624520" type="user"
            has-children="false" is-primary="false" is-hidden="false">
      <name>jazz doe</name> 
      <login>jazzdoe@example.com</login> 
      <email>jazzdoe@newcompany.com</email> 
    </principal>
    

List all guests on the server

  1. Call report-bulk-users, filtering for a type of guest:
    https://example.com/api/xml?action=report-bulk-users
    &filter-like-type=guest

    Use filter-like-type=guest, rather than filter-type=guest.

  2. Parse the row elements in the response:
    <row principal-id="51157227">
      <login>joy@acme.com</login> 
      <name>joy@acme.com</name> 
      <email>joy@acme.com</email> 
      <type>guest</type> 
    </row>
    

List all users who report to a specific manager

When you call principal-info with a principal-id, the response shows the principal. If the principal is a user who has a manager assigned in Connect Enterprise, the response also shows data about the principal's manager in a manager element:

<manager account-id="624520" disabled="" has-children="false" 
is-hidden="false" is-primary="false" principal-id="2006282569"
type="user"> <ext-login>jazzdoe@example.com</ext-login> <login>jazzdoe@example.com</login> <name>jazz doe</name> <email>joy@example.com</email> <first-name>jazz</first-name> <last-name>doe</last-name> <x-2006293620>23456</x-2006293620> <x-2007017651>chicago</x-2007017651> </manager>

You can use the manager's principal-id with principal-list to list all users who are assigned to the manager.

  1. Call principal-list, filtering on manager-id:
https://example.com/api/xml?action=principal-list
&filter-manager-id=2006282569
  1. Parse the response for the principal elements:
<principal principal-id="2006258745" account-id="624520" type="user" 
has-children="false" is-primary="false" is-hidden="false"
manager-id="2006282569"> <name>Suzanne Alexandra</name> <login>suzannea@adobe.com</login> <email>suzannea@adobe.com</email> </principal>


Take a survey


 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/03_perm3.htm