Availability

Breeze 4

Description

Provides information about one principal, either a user or a group.

You must specify a principal-id. To find the principal-id, call principal-list, using a filter if necessary to limit the response.

Request URL

 http://server_name/api/xml 
     ?action=principal-info 
     &principal-id=integer 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

principal-id

BIGINT

Y

The ID of a user or group you want information about. You can get the ID by calling principal-list.

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 />  
     <contact> 
         <email>string</email>  
         <first-name>string</first-name>  
         <last-name>string</last-name>  
     </contact> 
     <manager account-id=integer disabled=boolean has-children=boolean  
                 is-hidden=boolean is-primary=boolean principal-id=integer 
                 type=allowedValue> 
         <ext-login>string</ext-login>  
         <login>string</login>  
         <name>string</name>  
         <email>string</email>  
         <first-name>string</first-name>  
         <last-name>string</last-name>  
         <x-customfield1>string</x-customfield1> 
         <x-customfield2>string</x-customfield2> 
         ... 
     </manager> 
     <preferences acl-id=integer lang=allowedValue  
             time-zone-id=allowedValue />  
     <principal account-id=integer disabled=boolean has-children=boolean  
             is-hidden=boolean is-primary=boolean principal-id=integer 
             type=allowedValue> 
         <description>string</description> 
         <ext-login>string</ext-login>  
         <login>string</login>  
         <name>string</name>  
         <email>string</email>  
         <first-name>string</first-name>  
         <last-name>string</last-name>  
         <x-customfield1>string</x-customfield1> 
         <x-customfield2>string</x-customfield2> 
         ... 
     </principal> 
 </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).

contact

Container

Information about the contact person for a principal. If the principal is a user, usually the same as information in principal.

email

String

The e-mail address of the contact person.

first-name

String

The first name of the contact person.

last-name

String

The last name of the contact person.

manager

Container

Information describing a user’s manager, who is also a principal.

principal

Container

Information describing the principal.

account-id

BIGINT

The ID of the account the principal belongs to.

disabled

Datetime

If the principal’s account is valid, a null value returned as "". If the account is disabled, the date it was disabled.

has-children

Boolean

Whether the principal has children. Groups have children and users don’t, so this attribute indicates whether the principal is a group.

is-hidden

Boolean

Whether the principal is hidden (true) or not (false) in Connect Central or your application.

is-primary

Boolean

Whether the principal is a built-in group (true) or not (false).

principal-id

BIGINT

The ID of the principal.

type

Allowed value

The type of principal (see type for values).

description

String

For a group, the group name.

ext-login

String

For a user, the login ID sent from an external network. By default, the same value as login, so change it if you use external authentication.

login

String

The principal’s login ID on Adobe Connect. Can be the same as an e-mail address.

name

String

For a user, the full name, concatenated from first-name and last-name.

email

String

For a user, the e-mail address.

first-name

String

For a user, the first name.

last-name

String

For a user, the last name.

x-customfield

String

A custom field defined for the user or group.

preferences

Empty, with attributes

Information about the principal’s preferences.

acl-id

BIGINT

The principal’s ID.

lang

Allowed value

The language setting the principal has chosen for Adobe Connect applications.

time-zone-id

Allowed value

The time zone setting the principal has chosen for Adobe Connect applications.

Sample request

 https://example.com/api/xml?action=principal-info&principal-id=2006258745

Sample response

 <?xml version="1.0" encoding="utf-8" ?>  
 <results> 
     <status code="ok" />  
     <contact> 
         <email>bob@acme.com</email>  
         <first-name>Bob</first-name>  
         <last-name>Jones</last-name>  
     </contact> 
     <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>jazzdoe@example.com</email>  
         <first-name>Jazz</first-name>  
         <last-name>Doe</last-name>  
         <x-2007017651>San Francisco</x-2007017651>  
     </manager> 
     <preferences acl-id="2006258745" lang="en" time-zone-id="4" />  
     <principal account-id="624520" disabled="" has-children="false"  
                 is-hidden="false" is-primary="false" principal-id="2006258745" 
                 type="user"> 
         <ext-login>joy@acme.com</ext-login>  
         <login>joy@acme.com</login>  
         <name>Joy Smith</name>  
         <email>joy@acme.com</email>  
         <first-name>Joy</first-name>  
         <last-name>Smith</last-name>  
         <x-2007017651>San Francisco</x-2007017651>  
     </principal> 
 </results>

See also

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy