Home
/
API reference
/
API documentation (JSON/XML)
/
Tasks
/
AuthSession tasks

AuthSession delete

API reference (XML/JSON) · Updated 2025-03-17

Function

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

Description

Route: DELETE /logout

The SessionID must be specified in the header

X-Domainrobot-SessionId: b3a9489e-e40e-41e2-a3eb-01a26f2aba3b

{
}

{
    "stid": "20200722-app2-dev-19946",
    "status": {
        "code": "S1321003",
        "text": "The session token was deleted successfully.",
        "type": "SUCCESS"
    }
}

Task code: 1321003
Uses User object

Example with auth block

<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

<request>
	<auth_session>
		<hash>123..</hash>
	</auth_session>
	<task>
		<code>1321003</code>
	</task>
</request>

<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>