JOC API

/authentication/logout

POST

Logs out and closes session

Request

Name	Description	Example	Type	Constraints	Default
Headers
X-Access-Token*	Request requires authentication!	550e8400-e29b-11d4-a716-446655440000	string

Responses

Code	Description	Headers	Body
200	Confirm 'logout' successfully		application/json model \| example { "title": "authentication", "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "required": [ "isAuthenticated" ], "properties": { "accessToken": { "type": "string" }, "account": { "type": "string" }, "callerHostName": { "type": "string" }, "callerIpAddress": { "type": "string" }, "enableTouch": { "type": "boolean", "default": true }, "forcePasswordChange": { "type": "boolean", "default": false }, "hasRole": { "type": "boolean", "default": false }, "identityService": { "type": "string" }, "isApprovalRequestor": { "type": "boolean", "default": false }, "isApprover": { "type": "boolean", "default": false }, "isAuthenticated": { "type": "boolean" }, "isPermitted": { "type": "boolean", "default": false }, "message": { "type": "string" }, "role": { "type": "string" }, "sessionTimeout": { "type": "integer", "default": 1800 } } } { "accessToken": "", "account": "root", "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false } { "accessToken": "", "account": "root", "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false }

Code

Description

Headers

Body

200

Confirm 'logout' successfully

application/json

model | example

{
    "title": "authentication",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "required": [
        "isAuthenticated"
    ],
    "properties": {
        "accessToken": {
            "type": "string"
        },
        "account": {
            "type": "string"
        },
        "callerHostName": {
            "type": "string"
        },
        "callerIpAddress": {
            "type": "string"
        },
        "enableTouch": {
            "type": "boolean",
            "default": true
        },
        "forcePasswordChange": {
            "type": "boolean",
            "default": false
        },
        "hasRole": {
            "type": "boolean",
            "default": false
        },
        "identityService": {
            "type": "string"
        },
        "isApprovalRequestor": {
            "type": "boolean",
            "default": false
        },
        "isApprover": {
            "type": "boolean",
            "default": false
        },
        "isAuthenticated": {
            "type": "boolean"
        },
        "isPermitted": {
            "type": "boolean",
            "default": false
        },
        "message": {
            "type": "string"
        },
        "role": {
            "type": "string"
        },
        "sessionTimeout": {
            "type": "integer",
            "default": 1800
        }
    }
}

{ "accessToken": "", "account": "root", "enableTouch": true, "forcePasswordChange": false, "hasRole": false, "isApprovalRequestor": false, "isApprover": false, "isAuthenticated": false, "isPermitted": false }

{
    "accessToken": "",
    "account": "root",
    "enableTouch": true,
    "forcePasswordChange": false,
    "hasRole": false,
    "isApprovalRequestor": false,
    "isApprover": false,
    "isAuthenticated": false,
    "isPermitted": false
}