Toggle menu

updateSession

Updates the specified auth session.

Parameters

NameTypeDescription
serverIdString, requiredA value that must match the API Server's current serverId
authSessionIdString, requiredId of the auth session to update
returnUrlString, optionalUrl to return to after passing through the authentication system without an error
errorReturnUrlString, optionalUrl to return to after an error within the authentication worker occurs

Response Fields

NameTypeDescription
authenticatedbooleanTrue if successfully updated, otherwise a JSONRPC error is returned

Example Request

{
    "id": "1",
    "jsonrpc": "2.0",
    "method": "updateSession",
    "params": {
        "serverId": "56B3C7C0-01F7-4742-8D70-1070C40390F2",
        "authSessionId":  "9ea979c2-c0da-456e-8ed4-235df4fac8d9"
    }
}

Last modified on June 27, 2023

Share this page

Facebook icon Twitter icon email icon

Print

print icon