X-UserContext HTTP Header (MV-SIPN only)
For API services consumed through MV-SIPN, Swift API Gateway will establish a session with API provider. After successfully establishing the session, Swift API Gateway will create X-UserContext HTTP header and forward this header to the API service. This header contains a signed JWT token including information about the API consumer. The signed JWT token contains the following headers and claims.
| Headers | Descriptions |
|---|---|
| typ | Type. It is JWT. |
| alg | Algorithm. This parameter defines the signing algorithm used for the JWT. It is RS256. |
| x5c | This parameter is the Swift API Gateway's public certificate for verifying the JWT. |
| Claims | Descriptions |
|---|---|
| iss | Issuer. This is the issuer of the token. https://api.swiftnet.sipn.swift.com for Live environment and https://api-test.swiftnet.sipn.swift.com for Pilot environment. |
| sub | Subject. Swift API Gateway will use Application Security. |
| aud | Audience. This is the audience of the token. It should contain the URI of the API service URL provided by the API Provider. For example, https://gss-screening-api-pilot.swiftnet.sipn.swift.com/v1/transaction for the pilot environment, https://gss-screening-api.swiftnet.sipn.swift.com/v1/transaction for the Live environment. |
| iat | Issued at. This is the token creation timestamp in NumericDate (number of seconds from 1970-01-01T00:00:00Z UTC). It should be no more than 15 minutes before the expiration time defined in the claim. |
Previous page Session Distribution
Next pageDeveloper Tools