Overview | Service | Command |
Get Information about an account
Authorization token required | true |
Admin Authorization token required | false |
<GetAccountInfoRequest> ## GetAccountInfoRequest
<account by="{acct-selector-by} (adminName|appAdminName|id|foreignPrincipal|name|krb5Principal)">{key}</account> ## AccountSelector
</GetAccountInfoRequest>
The following table describes elements and attributes you can define within a
<GetAccountInfoRequest>
element:
XPath | Required / Optional | Description |
/account | Required (only 1) | Type:{key} Use to identify the account Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by} |
/account@by | Required (only 1) | Type:adminName|appAdminName|id|foreignPrincipal|name|krb5Principal Select the meaning of {acct-selector-key} |
Provides a limited amount of information about the requested account.
Note: there are some minor differences between the Admin and Account versions of GetAccountInfoResponse.
<GetAccountInfoResponse> ## GetAccountInfoResponse
<name>{name} (String)</name>
(<attr name="{name}">{value}</attr> ## NamedValue)+
<soapURL>{soapURL} (String)</soapURL>
<publicURL>{publicURL} (String)</publicURL>
<changePasswordURL>{changePasswordURL} (String)</changePasswordURL>
<communityURL>{communityURL} (String)</communityURL>
<adminURL>{adminURL} (String)</adminURL>
<boshURL>{boshURL} (String)</boshURL>
</GetAccountInfoResponse>
The following table describes elements and attributes you can define within a
<GetAccountInfoResponse>
element:
XPath | Required / Optional | Description | ||||||
/name | Required (only 1) | Type:{name} (String) Account name - an email address (user@domain) |
||||||
/attr | Required (1 or more) | Type:{value} Account attributes. Currently only these attributes are returned:
Description for element text content:Value |
||||||
/attr@name | Required (only 1) | Type:String Name |
||||||
/soapURL | Optional (0 or 1) | Type:{soapURL} (String) URL to talk to for soap service for this account. e.g.: http://server:7070/service/soap/ If both http and https (SSL) are enabled, the https URL will be returned. |
||||||
/publicURL | Optional (0 or 1) | Type:{publicURL} (String) Base public URL for the requested account |
||||||
/changePasswordURL | Optional (0 or 1) | Type:{changePasswordURL} (String) URL to talk to in order to change a password. Not returned if not configured via domain attribute zimbraChangePasswordURL |
||||||
/communityURL | Optional (0 or 1) | Type:{communityURL} (String) Zimbra Community URL to load in Community tab. The URL points to /api.ashx/v2/oauth/redirect script in Zimbra Community and contains signed GET parameters used by Zimbra Community to authenticate current user. This parameter is returned only when zimbraFeatureSocialExternalEnabled is set to TRUE and the following attributes are configured: zimbraCommunityAPIClientID, zimbraCommunityAPIClientSecret, zimbraCommunityUsernameMapping,zimbraCommunityBaseURL,zimbraCommunityHomeURL |
||||||
/adminURL | Optional (0 or 1) | Type:{adminURL} (String) base URL for accessing the admin console |
||||||
/boshURL | Optional (0 or 1) | Type:{boshURL} (String) Proxy URL for accessing XMPP over BOSH. Should be returned only when zimbraFeatureChatEnabled is set to TRUE for Account/COS |