Carbonio SOAP API Reference 23.11.0_ZEXTRAS

Command

Service: zimbraAccount

Command: GetShareInfo
Namespace: urn:zimbraAccount
Description: Get information about published shares

Properties:

Authorization token required	true
Admin Authorization token required	false

GetShareInfoRequest

Notes:

if <owner> is *not* specified the server will search the LDAP directory for published shares (zimbraSharedItem account attribute) accessible to the authed user.
if <owner> *is* specified, the server will iterate through the owner's mailbox to discover all shares applicable to the authed user, instead of looking at any of the published share info.

All applicable shares will be returned, including any shares that are:

shared with the account directly
shared with any group(and parent groups) the account belongs.	(is supported)
shared with the cos assigned to the account.	(is supported)
shared with the domain this account is in.	(is supported)
shared with all authed users (i.e. all Zimbra users)	(is supported)
shared with the public	(is supported)

e.g.

What folders are shared with any of the groups I belong to?

folders of any user

              <GetShareInfoRequest>
                  <grantee type="grp">
              </GetShareInfoRequest>

folders of a particular user

              <GetShareInfoRequest>
                  <grantee type="grp">
                  <owner by="name">user1@example.com</owner>
              </GetShareInfoRequest>

What folders does a particular user share with me?

include all folders directly shared with me and shared with an entry I can inherit shares from:

              <GetShareInfoRequest>
                  <owner by="name">user1@example.com</owner>
              </GetShareInfoRequest>

include only folders directly shared with me.

              <GetShareInfoRequest>
                  <grantee type="usr">
                  <owner by="name">user1@example.com</owner>
              </GetShareInfoRequest>

Show me all folders shared directly with me and with any entry I can inherit shares from:

              <GetShareInfoRequest>
              </GetShareInfoRequest>

    <GetShareInfoRequest [internal="(0|1)"] [includeSelf="(0|1)"]> ## GetShareInfoRequest
        <grantee [type="{grantee-type}"] [id="{grantee-id}"] [name="{grantee-name}"] /> ## GranteeChooser
        <owner by="{acct-selector-by} (adminName | appAdminName | id | foreignPrincipal | name | krb5Principal)">{key}</owner> ## AccountSelector
    </GetShareInfoRequest>

elements and attributes you can define within a <GetShareInfoRequest> element:

XPath	Required / Optional	Description
@internal	Optional (0 or 1)	Type: 0\|1 Flags that have been proxied to this server because the specified "owner account" is homed here. Do not proxy in this case. (Used internally by ZCS)
@includeSelf	Optional (0 or 1)	Type: 0\|1 Flag whether own shares should be included: 0 if shares owned by the requested account should not be included in the response 1 (default) include shares owned by the requested account (It might be useful to see the shares I've shared to a DL that I belong to so that I know I'm sharing it correctly.)
/grantee	Optional (0 or 1)	Filter by the specified grantee type
/grantee@type	Optional (0 or 1)	Type: String If specified, filters the result by the specified grantee type.
/grantee@id	Optional (0 or 1)	Type: String If specified, filters the result by the specified grantee ID.
/grantee@name	Optional (0 or 1)	Type: String If specified, filters the result by the specified grantee name.
/owner	Optional (0 or 1)	Type: {key} Specifies the owner of the share Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by}
/owner@by	Required (only 1)	Type: adminName \| appAdminName \| id \| foreignPrincipal \| name \| krb5Principal Select the meaning of {acct-selector-key}

GetShareInfoResponse

    <GetShareInfoResponse> ## GetShareInfoResponse
        (<share ownerId="{share-owner-id}" ownerEmail="{share-owner-email}" ownerName="{share-owner-display-name}"
                    folderId="{share-folder-id} (int)" folderUuid="{share-folder-uuid}"
                    folderPath="{share-fully-qualified-path}" view="{share-default-view}" rights="{share-rights}"
                    granteeType="{grantee-type}" granteeId="{grantee-id}" granteeName="{grantee-name}"
                    granteeDisplayName="{grantee-display-name}" [mid="{mountpoint-id}"] /> ## ShareInfo)*
    </GetShareInfoResponse>

elements and attributes you can define within a <GetShareInfoResponse> element:

XPath	Required / Optional	Description
/share	Optional (0 or more)	Shares
/share@ownerId	Required (only 1)	Type: String Owner ID
/share@ownerEmail	Required (only 1)	Type: String Owner email
/share@ownerName	Required (only 1)	Type: String Owner display name
/share@folderId	Required (only 1)	Type: int Folder ID
/share@folderUuid	Required (only 1)	Type: String Folder UUID
/share@folderPath	Required (only 1)	Type: String Fully qualified path
/share@view	Required (only 1)	Type: String Default type
/share@rights	Required (only 1)	Type: String Rights
/share@granteeType	Required (only 1)	Type: String Grantee type
/share@granteeId	Required (only 1)	Type: String Grantee ID
/share@granteeName	Required (only 1)	Type: String Grantee name
/share@granteeDisplayName	Required (only 1)	Type: String Grantee display name
/share@mid	Optional (0 or 1)	Type: String Returned if the share is already mounted. Contains the folder id of the mountpoint in the local mailbox.