ジャンプ先

• リクエスト
• レスポンス
• 例

ユーザーのログアウト

get

/oiri/api/v1/logout

apiは、`JSESSIONID` Cookieを無効にして、ユーザーをログアウトします。

リクエスト

この操作にはリクエスト・パラメータはありません。

この操作にはリクエスト本文はありません。

セキュリティ

• JSESSIONID: apiKey
  型: apiKey

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

OK。レスポンスがOKの場合、HTTPステータス・コード200が返されます。ログアウト操作により、ユーザー・セッションが終了します。

ヘッダー

• Set-Cookie:

Body ()

ルート・スキーマ: schema

型: object

ソースを表示

• message(optional): string

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

401レスポンス

認可されていません

Body ()

ルート・スキーマ: Error

型: object

ソースを表示

• code: string
• message: string

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

先頭に戻る

例

次の例は、ユーザーをログアウトする方法を示しています。

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

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{message: "User logged out"}

先頭に戻る