XLG-FDN-P-SessionValidate

XLG-FDN-P-SessionValidate 1.0.0

0
No votes yet
session-validate-sso

This service is meant to validate de Session in SSO for Mexico supported backend

forum Discuss this API in the forum
production
development
https://api.banamex.com/mx-gcgapi

Paths

/v1/x-global/sso/session/validate

post /v1/x-global/sso/session/validate
session-validate-sso

Validate the session in a specific backend.

This API is meant to validate the session for a specific system and promote the scope to Customer

OAuth2 Application Flow
OAuth2 Application Flow
(oauth2 application)
Token URL
https://api.banamex.com/mx-gcgapi/api/v1/oauth/token
Scopes
/api/v1
ClientID
X-IBM-Client-Id
(apiKey located in header)
uuid
Required in header
string

A 128 bit universally unique identifier (UUID) that you generate for every request and is used for tracking. It is recommended to use the output from Java UUID class or an equivalent.If not provided by, PSG will automatically inject one.

{
    "default": "a7d1e304-83a9-4413-af97-62615e57eae66807840"
}
Accept
Optional in header
string

Content-Types that are acceptable for the response. Currently we support application/json by default.

{
    "default": "application\/json"
}
Content-Type
Required in header
string

application/json.If not provided, PSG will automatically inject default (application/json)

{
    "default": "application\/json"
}
Accept-Language
Optional in header
string

HTTP Accept-Language header.If not provided, PSG will automatically inject default (application/json)

{
    "default": "en-US"
}
countryCode
Required in header
string

2 character ISO country code.If not provided, PSG will automatically inject default (MX)

{
    "default": "MX"
}
businessCode
Required in header
string

3 character business code.If not provided, PSG will automatically inject default (GCB)

{
    "default": "GCB"
}
channelId
Required in header
string

channel Id used by the user.

client_id
Required in header
string

The client ID you received during application registration in the developer portal

Authorization
Required in header
string

Bearer token aquired from APIM token endpoint

SessionValidateRequest
Required in body
object

Request object with the data to validate the session

SessionValidateRequest
200

Session Validated successfully

400

(BAD REQUEST) - Request was not processed

TypeCodeDetails
invalidinvalidRequestMissing or invalid Parameters
invalidinvalidHMAC629-HMAC comparison failed
invalidinvalidServerRandom630-EventID/Server random comparison failed
errorcannotDecryptData620-Cannot decrypt, please re-check the encrypted value.

ErrorResponse
403

(FORBIDDEN) - Unauthorized to perform the requested operation on resource

TypeCodeDetailsMore Info
invalidaccessNotConfiguredThe request operation is not configured to access this resourceChannel/Country/Business provided in the request is not supported currently

ErrorResponse
500

(INTERNAL SERVER ERROR) - API Server Error

TypeCodeDetails
fatalserverUnavailableThe request failed due to an internal error/server unavailability
errorhostSystemNotSupportedHost backend system not supported.

ErrorResponse
Example Request
Example Response
POST https://api.banamex.com/mx-gcgapi/api/v1/x-global/sso/session/validate
Try this operation
https://api.banamex.com/mx-gcgapi/api/v1/x-global/sso/session/validate
content-type
accept
uuid
Accept-Language
countryCode
businessCode
channelId
client_id
Authorization

Definitions 

{
    "type": "object",
    "required": [
        "customerId",
        "sessionContext"
    ],
    "properties": {
        "customerId": {
            "type": "string",
            "description": "this is the customer Id of client"
        },
        "sessionContext": {
            "type": "string",
            "description": "this is the session context with a length 49 positions"
        }
    }
}
              
{
    "required": [
        "code",
        "type"
    ],
    "properties": {
        "type": {
            "type": "string",
            "description": "
invalid - Request did not confirm to the specification and was unprocessed & rejected. Please fix the value and try again
 
warn - Request was partially processed.  E.g. some of the fields are missing in response to the system issues,  request was accepted successfully but will be processed asynchronously
                                                           
error - The request was accepted but could not be processed successfully
            
fatal - There was an internal system error while processing the request. These are technical errors and will be resolved by Citi, and the consumer should retry after some time. Business errors will not be categorized as fatal 
",
            "enum": [
                "error",
                "warn",
                "invalid",
                "fatal"
            ]
        },
        "code": {
            "type": "string",
            "description": "Error code which qualifies the error"
        },
        "details": {
            "type": "string",
            "description": "Human readable explanation specific to the occurrence of the problem"
        }
    }
}