Find a principal-id

A principal is a user or group that has a defined permission to interact with a SCO on the server. You can create users and groups for your organization and modify their permissions.

Connect Enterprise also has built-in groups: Administrators, Authors, Training Managers, Event Managers, Meeting Hosts, and Seminar Hosts. You can add users and groups to built-in groups, but you can't modify the permissions of built-in groups.

Each Connect Enterprise user and group has a principal-id. In some API calls, the principal-id is called a group-id or user-id to distinguish it from other values. The value of the ID that identifies a user or group is always the same, regardless of its name. You can check the syntax of any action in Action reference.

Get the principal-id of a user or group

Call principal-list with a filter:
```
https://example.com/api/xml?action=principal-list&filter-name=jazz doe
```
It is best to use filter-name, filter-login, or filter-email for an exact match. Be careful with filter-like-name, as it may affect server performance.

Parse the principal elements in the response for the principal-id:

<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>

Get the principal-id of the current user

Call common-info after the user is logged in:

https://example.com/api/xml?action=common-info

Parse the user elements in the response for the user-id:
```
<user user-id="2007124930" type="user">
        <name>jazz doe</name> 
        <login>jazz@doe.com</login> 
</user>
```
Here, the principal-id is called user-id, because it always represents a user who is authenticated to Connect Enterprise. A group cannot log in to the server. You can pass the user-id value as a principal-id in other actions.

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_perm2.htm