CreateHandoffId

Creates a handoff authentication id with security token.

note

• The handoff credential created by CreateHandoffId expires after 1 hour. This is not configurable.
• It is single-use — it is deleted the first time it is presented to AuthenticateHandoff with the correct security token, even if that authentication then fails, so a retry needs a new handoff id.
• A user can only have one handoff id active at a time. Creating a new one deletes the previous one.

Service	Operation
identity	CREATE_HANDOFF_ID

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

-- N/A

GDScript

N/A

Lua

-- Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var identityProxy = bridge.getIdentityServiceProxy();

var postResult = identityProxy.createHandoffId();
if (postResult.status == 200) {
    // Success!
}

Raw

// Cloud Code only. To view example, switch to the Cloud Code tab

JSON Response

{
    "data": {
        "securityToken": "9XRVaE",
        "handoffId": "a30dcdf8-88ed-4b16-b313-59c8ee3feb06"
    },
    "status": 200
}