From Bright Pattern Documentation
(Created page with "<translate>= Session Check = This method checks that a session exists, and then it returns the ID of the user who has the session. Session Check also extends the life of the...") |
(Updated via BpDeleteTranslateTags script) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | = Session Check = | |
This method checks that a session exists, and then it returns the ID of the user who has the session. | This method checks that a session exists, and then it returns the ID of the user who has the session. | ||
Session Check also extends the life of the session by 15 minutes (full session inactivity timeout). | Session Check also extends the life of the session by 15 minutes (full session inactivity timeout). | ||
| − | == Method == | + | == HTTP Method == |
GET | GET | ||
| Line 13: | Line 13: | ||
GET /session_check?session_id=8439309F-4C70-44CF-9D92-FA0E56C97BD0 HTTP/1.1 | GET /session_check?session_id=8439309F-4C70-44CF-9D92-FA0E56C97BD0 HTTP/1.1 | ||
| − | == | + | == Responses == |
A success response includes the "200 OK" with application/JSON body containing ''session_id''. | A success response includes the "200 OK" with application/JSON body containing ''session_id''. | ||
| + | |||
| + | An error response is returned with a 4xx HTTP response code and a JSON body containing detailed error information. | ||
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| Line 30: | Line 32: | ||
"user_id":"9E33BE47-47DF-40F7-B160-8B90E12FE6C5" | "user_id":"9E33BE47-47DF-40F7-B160-8B90E12FE6C5" | ||
} | } | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| 401 | | 401 | ||
| Line 47: | Line 39: | ||
|- | |- | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
Session Check
This method checks that a session exists, and then it returns the ID of the user who has the session.
Session Check also extends the life of the session by 15 minutes (full session inactivity timeout).
HTTP Method
GET
Request
session_check (session_id)
Example
GET /session_check?session_id=8439309F-4C70-44CF-9D92-FA0E56C97BD0 HTTP/1.1
Responses
A success response includes the "200 OK" with application/JSON body containing session_id.
An error response is returned with a 4xx HTTP response code and a JSON body containing detailed error information.
| Code | Description | Example |
| 200 | OK |
HTTP/1.1 200 OK
{
“session_id”: “8439309F-4C70-44CF-9D92-FA0E56C97BD0”,
"tenant_id":"4E3707BE-CD47-4627-A5D9-34EF70A0DE42",
"user_id":"9E33BE47-47DF-40F7-B160-8B90E12FE6C5"
}
|
| 401 | not authenticated |
{ “error” : “not_logged_in” }
|