Jump to

• Request
• Response
• Examples

Logout user

get

/oiri/api/v1/logout

api logs out user by invalidating the `JSESSIONID` cookie.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Security

• JSESSIONID: apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK. If response is OK, HTTP status code 200 is returned. Logout operation ends users session.

Headers

• Set-Cookie:

Body ()

Root Schema : schema

Type: object

Show Source

• message(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code: string
• message: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

Back to Top

Examples

The following example shows how to log out a user.

curl -X GET\
-H "Accept: application/json"\
"http://localhost:port/oiri/api/v1/logout"

Example of the Response Body

The following is an example of the response body in JSON format.

{message: "User logged out"}

Back to Top