Overview

Get the context of the session. It is to get the user (encrypted) or app context (plain).

If the response is encrypted, it shall be flagged "encrypted".

  "desc": {
    "en": "Success",
    "ar": "نجاح",
    "code": "encrypted"
  }

The consumer shall use algorithm mentioned in the "Sample Key" section to decrypt.

💡

This is a protected resource. The request shall embed the Bearer in the Authorization header.

Flow - GetContextApp

Exception Handling

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

Error Code	Description	Exception Handling
ESB-IDP-E0001	JWT is tampered	Authenticate to IDP to get the new JWT
ESB-IDP-E0002	Session or JWT is expired	RefreshSession to IDP to refresh the session and get the new JWT
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
ESB-IDP-E0005	Context not found or invalid	Back to IID Portal

Sample Key

Use this tool to descrypt the context with following secretKey.

This is sample DET-IDP secretKey

Algorithm

{
  "alg": "dir",
  "enc": "A128GCM"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success-UserContext

application/json

Body

Examples

PlainEncrypted

{
    "status": 200,
    "esbUUID": "51368f50-4a67-42d4-803c-ddc80c0be491",
    "desc": {
        "en": "Success",
        "ar": "نجاح",
        "code": "plain"
    },
    "data": {
        "context": {
            "user": {
                "sessionId": "c9e12c13-589e-4f3a-9273-e9300fda0ee3",
                "externalSystemId": "chatbot",
                "authorityType": "SELF",
                "selfProfile": [
                    {
                        "profileId": 601804,
                        "nameEn": "DAWOOD ALI ABDULLA ALI AHMAD",
                        "nameAr": "داود على عبدالله على احمد",
                        "mobileNo": "058597xxxx",
                        "email": "john@icloud.com",
                        "type": "INDIVIDUAL",
                        "isActive": true
                    }
                ]
            }
        }
    }
}

🟢200Success-AppContext

🟠403Forbidden

🟠401Unauthorized

🔴500Server Error

🔴504APIMGatewayTimeout

🟠403APIMDeveloperInactive

🟠404FlogoException

🔴500Unknown Error

GetContext App

Overview#

Flow - GetContextApp#

Exception Handling#