Refresh Session

Integrating

POST

https://apiqa.detsandbox.com/idp/sso/v1/refresh

Last modified:2024-09-26 10:49:59

OperationId:RefreshSession

Overview

The Application Workspace may call RefreshSession API to force the session to be refreshed; hence, IDP will issue a new JWT.

Sequence Diagram

Exception Handling

Below is the exception handling scenario if exception occurred (HTTP 401 - Unauthorized)

Error Code	Description	Exception Handling
ESB-IDP-E0003	Session ID and/or sessionToken is invalid	Back to anonymous or request user to sign in
ESB-IDP-E0004	User logged out	Back to anonymous or request user to sign in

Request

Header Params

Body Params application/json

Example

{
    "sessionToken": "{{sessionToken}}",
    "sessionId": "{{sessionId}}"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apiqa.detsandbox.com/idp/sso/v1/refresh' \
--header 'X-Request-Id: {% faker datatype.uuid %}' \
--header 'api_key: 5k5a9rnknaj87kthytganapc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sessionToken": "",
    "sessionId": "{{sessionId}}"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "esbUUID": "51368f50-4a67-42d4-803c-ddc80c0be491",
    "desc": {
        "en": "Success",
        "ar": "نجاح",
        "code": "ESB-IDP-S0000"
    },
    "data": {
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJJSUQtSURQU2VydmljZXMiLCJzdWIiOiJjaGF0Ym90IiwiYXVkIjoiU1NPIiwiY29udGV4dCI6eyJ1c2VyIjp7InNlbGZQcm9maWxlIjpbeyJwcm9maWxlSWQiOjYwMTgwNCwibmFtZUVuIjoiREFXT09EIEFMSSBBQkRVTExBIEFMSSBBSE1BRCIsIm5hbWVBciI6Itiv2KfZiNivINi52YTZiSDYudio2K_Yp9mE2YTZhyDYudmE2Ykg2KfYrdmF2K8iLCJtb2JpbGVObyI6IjA1ODU5eHh4eCIsImVtYWlsIjoiam9obkBpY2xvdWQuY29tIiwidHlwZSI6IklORElWSURVQUwiLCJpc0FjdGl2ZSI6dHJ1ZX1dfSwiYXBwIjp7ImlpZFBhcmFtcyI6eyJ0ZXN0Ijp7ImEiOjAsImIiOjB9fX0sInNzbyI6eyJzZXNzaW9uSWQiOiJjOWUxMmMxMy01ODllLTRmM2EtOTI3My1lOTMwMGZkYTBlZjEiLCJleHRlcm5hbFN5c3RlbUlkIjoiY2hhdGJvdCIsImF1dGhvcml0eVR5cGUiOiJTRUxGIiwic2Vzc2lvblRva2VuRW5jcnlwdGVkIjoidi95VGxScUc3dmpGYmV3anpaTmhLMllsSHRQd2liWUxKTWpPWTZnSGYranJYUklKZnc2cmZRRHdURTArM0VlUiJ9fX0.92Um5tC4JTm0_cuvcpf6YGjcwa_CrG4IpsGM5GUCPRQ"
    }
}

🟠403Forbidden

🟠401Unauthorized

🔴500Server Error

🔴504APIMGatewayTimeout

🟠403APIMDeveloperInactive

🟠404FlogoException

🔴500Unknown Error

🔴503APIMServiceUnavailable

Modified at 2024-09-26 10:49:59

Authenticate

GetContext App