Newer Version Available

This content describes an older version of this product. View Latest

Client

The Client object is a JSON-formatted object returned by the signed request in the CanvasRequest object. It contains context information about the client app.

Field Description
instanceId The ID of a canvas app exposed on a Visualforce page. Used internally for canvas app instance management.
instanceUrl The URL of the Salesforce instance. For example, http://instance.salesforce.com. This is used to preface the URLs returned by the Links object.
oauthToken The OAuth access token that’s returned to the caller.
targetOrigin The URL of the canvas app. Used internally for cross-domain communication between the page and the iFrame that contains the canvas app.

The following code snippet shows an example of the Client object.

1"client":
2{
3    "instanceId":"06Px000000002JZ", 
4    "instanceUrl":"http://instance.salesforce.com:8080", 
5    "oauthToken":"00Dx0000X00Or4J!ARQAQJ34YLUq54RMTrQbxVoWUgorjFi3", 
6    "targetOrigin":"http://instance.salesforce.com:8080"
7}