Tags:
- Phase›Realized
production
development
https://aspac.sandbox.api.citi.com/gcbap
Custom Gateway API Endpoint
Paths
/password/oauth2/refresh
post /password/oauth2/refresh
Authorization Code Grant – Refresh Token Endpoint
Refresh access token
Endpoint for refreshing the access token issued for the grant type "Password"
To use this operation you must use one of the following sets of security requirements.
Client_Id (Query)
client_id
(apiKey located in query)
Client_Secret (Query)
client_secret
(apiKey located in query)
Client_Id
X-IBM-Client-Id
(apiKey located in header)
Client_Secret (Query)
client_secret
(apiKey located in query)
Client_Id (Query)
client_id
(apiKey located in query)
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)
Client_Id
X-IBM-Client-Id
(apiKey located in header)
Client_Secret
X-IBM-Client-Secret
(apiKey located in header)
Authorization
Required in header
string
HTTP Basic authentication by passing base64 encoded value of the client id and client secret separated by colon (:).Example: Base64(client_id:client_secret) will be passed as Basic KGNsaWVudF9pZDpjbGllbnRfc2VjcmV0KQ==
Content-Type
Required in header
string
Content type. Value is application/x-www-form-urlencoded
body
Optional in body
object
200
The request has succeeded
400
error |
invalid_request |
invalid_grant |
unsupported_grant_type |
unauthorized_client |
401
error |
invalid_client |
500
server_error
Example Request
Example Response
POST https://aspac.sandbox.api.citi.com/gcbap/api/password/oauth2/refresh
Definitions
{
"properties": {
"token_type": {
"type": "string",
"description": "The token type",
"example": "bearer"
},
"access_token": {
"type": "string",
"description": "This field should be passed as Authorization header in API request calls",
"example": "AAEkYzFjMDQ0Y2UtNTBmMy00NmY4LWI4YjEtYmQ5ODJkMWZiNGZh3xGP85xjqyxoHR7pXxzQJf223kWPL-HyWHD4zrRCvHZUkeBkTgxppbmpFtmWeVmjzDOxs1wFzI4s45YDS15eYmyuxzLbVog4d8H9pYSelrvL6naDYOLL9U16EaY0iyAMPBGX1H7RhCqtmd-7u_Eanw7QshbruLaZh2stOrdq2thC5CCSwW2r0e8PM1QbWubJOcMp8UGv-zNc0I3cTSihymSCF44HJ_yeuPAcXJ7kj-iPzQqxaO6FiWPmIsIh2YSxdGYo8alTyjJfG5AQDnM0HA"
},
"expires_in": {
"type": "number",
"description": "The access token expiry time (in seconds)",
"example": 1800
},
"scope": {
"type": "string",
"description": "The list of scopes separated by space",
"example": "/dda/customer /dda/accountlist /dda/account /dda/accountsdetails /dda/account/transactions"
},
"refresh_token": {
"type": "string",
"description": "The refresh token value",
"example": "AAGsyASCzlBplxGvA-5CFCkLhNinu6-0HQt-y7PuzsRLVAHok6yYs6KS2Np4t7bL0R8FMeT62wYXFxxY6F7LU_cc00QTXPfoQFFtay2tu3eGpBAGDg07ll_vNk_AEJo9l1GaEKYev7Q7drDOeRCDRqcD12zJzk36PsQEM6j1txFV2jR3snW5PLs3HVjxNRjUHWLR5IoI2qfb8zCZNahrFCRQ7T7ZVB_-E6Qk22tN3hZkZH7_kB3bZjtVoNxyjJ6qBDcrYdgtAvPvBV-xXDBmfUXD44JBYiZffHjEr2dFb_e3yA"
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"scope"
]
}
{
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_request",
"unauthorized_client",
"access_denied",
"unsupported_response_type",
"invalid_scope",
"server_error",
"temporarily_unavailable"
],
"description": "If the request fails due to a missing, invalid, or mismatching redirection URI, or if the client identifier is missing or invalid, the authorization server SHOULD inform the resource owner of the error and MUST NOT automatically redirect the user-agent to the invalid redirection URI."
},
"error_description": {
"type": "string",
"description": "Human-readable ASCII [USASCII] text providing additional information, used to assist the client developer in understanding the error that occurred"
},
"error_uri": {
"type": "string",
"description": "A URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error."
}
},
"required": [
"error"
]
}