Service: zimbraAccount
Namespace: "urn:zimbraAccount"
BootstrapMobileGatewayApp SOAP Command

This request is used by a mobile gateway app/client to bootstrap/initialize itself.

Authorization token required false
Admin Authorization token required false

BootstrapMobileGatewayAppRequest

    <BootstrapMobileGatewayAppRequest [wantAppToken="{want-app-token} (0|1)"] /> ## BootstrapMobileGatewayAppRequest

The following table describes elements and attributes you can define within a <BootstrapMobileGatewayAppRequest> element:

XPath Required / Optional Description
@wantAppToken Optional (0 or 1) Type:0|1
Whether an "anticipatory app account" auth token is desired.
Default is false.

BootstrapMobileGatewayAppResponse

    <BootstrapMobileGatewayAppResponse> ## BootstrapMobileGatewayAppResponse
        <appId>{appId} (String)</appId>
        <appKey>{appKey} (String)</appKey>
        <authToken [verifyAccount="(0|1)"] [lifetime="(Long)"]>{value}</authToken> ## AuthToken
    </BootstrapMobileGatewayAppResponse>

The following table describes elements and attributes you can define within a <BootstrapMobileGatewayAppResponse> element:

XPath Required / Optional Description
/appId Required (only 1) Type:{appId} (String)
Unique app ID for the app
/appKey Required (only 1) Type:{appKey} (String)
an app key (or a secret) to enable the app to authenticate itself in the future
/authToken Optional (0 or 1) Type:{value}
"Anticipatory" app account auth token
Description for element text content:Value for authorization token
/authToken@verifyAccount Optional (0 or 1) Type:0|1
If verifyAccount="1", <account> is required and the account in the auth token is compared to the named account. If verifyAccount="0" (default), only the auth token is verified and any <account> element specified is ignored.
/authToken@lifetime Optional (0 or 1) Type:Long
Life time of the auth token