Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleColor#FFFFFF
titleBGColor#E44313
titleTable of Contents

Table of Contents
maxLevel2
outlinetrue
stylenone

Function

With the AuthSessionDelete task, you delete a SessionID and thus end the working session for which you have authenticated yourself.

Description

SP Tabs group
dispositionhorizontal
SP Tab pane
anchor2286824
nameJSON

Route: DELETE /logout

Note
The SessionID must be specified in the header
X-Domainrobot-SessionId: b3a9489e-e40e-41e2-a3eb-01a26f2aba3b
Code Block
languagejs
titleRequest
linenumberstrue
collapsetrue
{
}
Code Block
titleResponse
linenumberstrue
collapsetrue
{
    "stid": "20200722-app2-dev-19946",
    "status": {
        "code": "S1321003",
        "text": "The session token was deleted successfully.",
        "type": "SUCCESS"
    }
}
SP Tab pane
anchor87031
nameXML

Task code: 1321003
Uses User object

Example with auth block

Code Block
languagexml
titleRequest
linenumberstrue
collapsetrue
<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>4</context>
	</auth>
	<task>
		<code>1321003</code>
		<auth_session>
			<hash>123..</hash>
		</auth_session>
	</task>
</request>

Example without auth block

Code Block
languagexml
titleRequest
linenumberstrue
collapsetrue
<request>
	<auth_session>
		<hash>123..</hash>
	</auth_session>
	<task>
		<code>1321003</code>
	</task>
</request>
Code Block
languagexml
titleResponse
linenumberstrue
collapsetrue
<response>
	<result>
		<data/>
		<status>
			<code>S1321003</code>
			<text>The session token was deleted successfully.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20151216-app1-dev-1280</stid>
</response>