Overview

Application Workspace authenticate to the system by calling IDP Services with the sessionToken(Short-Lived Session Token) and its signature. These are retrieved during the redirection thru the IID portal. IDP Services shall signs, issues a JWT embeded the claim data.

Subsequent call to the IID Core API for the same user's session should embed the token in the HTTP Header Authorization

Sequence Diagram

Pre-Condition:
User initiate CompleteMyApplication operation and IID Portal successfully generate external token and redirect the user to the Application Workspace.

Expected Condition:
IID SSO session is established

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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Examples

SuccessClaimData

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

🟠403Forbidden

🟠401Unauthorized

🔴500Internal Server Error

🔴504APIMGatewayTimeout

🟠403APIMDeveloperInactive

🟠404FlogoException

🔴503APIMServiceUnavailable

🔴500Unknown Error

Authenticate

Overview#

Sequence Diagram#

Exception Handling#

Request

Request samples

Responses

Overview

Sequence Diagram

Exception Handling