Auth.promoteSession

From Facebook Developer Wiki

Jump to: navigation, search

Contents

Description

Creates a temporary session secret for the current (non-infinite) session of a Web application. If a session secret already exists, this method returns the existing one.

This session secret will not be used in the signature for the server-side component of an application, it is only meant for use by applications which additionally want to use a client side component (for example, using the JavaScript Client Library).

Parameters

RequiredNameTypeDescription
required api_key string The application key associated with the calling application.
session_key string The session key of the logged in user.
sig string An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application.
v string This must be set to 1.0 to use this version of the API.
optional format string The desired response format, which can be either XML or JSON. (Default value is XML.)
callback string Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <auth_promoteSession_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/http://api.facebook.com/1.0/facebook.xsd"> 3e4a22bb2f5ed75114b0fc9995ea85f1 </auth_promoteSession_response>

Example Return JSON

"3e4a22bb2f5ed75114b0fc9995ea85f1"

Error Codes

CodeDescription
1 An unknown error occurred. Please resubmit the request.
2 The service is not available at this time.
101 The API key submitted is not associated with any known application.
102 The session key does not exist or has expired.
104 Incorrect signature.

See Also

reference