--- swagger: "2.0" info: x-ibm-name: singpass-authorisation-production title: SingPass Authorisation version: 1.0.3 description: "" schemes: - https basePath: /Authentication produces: - application/json securityDefinitions: clientSecretHeader (API Key): type: apiKey description: "" in: header name: X-IBM-Client-Secret clientIdHeader: type: apiKey in: header name: X-IBM-Client-Id security: - clientIdHeader: [] clientSecretHeader (API Key): [] x-ibm-configuration: testable: true enforced: true phase: realized paths: /SingPassToken: get: responses: 200: description: 200 OK schema: $ref: '#/definitions/TokenResponse' parameters: - name: scope type: string required: false in: query - name: callback_url type: string required: false in: query - name: code type: string required: false in: query /SingPassAuth: get: responses: 200: description: 200 OK schema: $ref: '#/definitions/AuthoriseResponse' parameters: - name: scope type: string required: false in: query - name: callback_url type: string required: false in: query - name: state type: string required: false in: query tags: [] consumes: - application/json definitions: TokenResponse: description: "" type: object properties: returnCode: type: integer format: int32 data: type: object properties: token: type: string code: type: string info: type: object properties: messageCode: type: number message: type: string fieldInfoList: type: array items: properties: field: type: string message: type: string type: object example: "{\r\n \"returnCode\": 10,\r\n \"data\": {\r\n\"token\": \"eyAidHlwIjogIkpXVCIsICJhbGciOiAiUlMyNTYiIH0.eyAic3ViIjogIlM5ODEyMzgxRCIsICJhdWRpdFRyYWNraW5nSWQiOiAiZjU0Njc3MGQtOTI4Ni00ODNlLTk0YzktZTllNDZlMTMwMzFiIiwgImlzcyI6ICJodHRwOi8vc3RnLWF1dGguYXBwcy5lLm5lY3Rhci5nb3Yuc2c6ODAvY29uc2VudC9vYXV0aDIiLCAidG9rZW5OYW1lIjogImFjY2Vzc190b2tlbiIsICJ0b2tlbl90eXBlIjogIkJlYXJlciIsICJhdXRoR3JhbnRJZCI6ICI4ZDRkNTEwNC0yMmMxLTRkZDYtYTA5Mi0yYmU3YzZlNzkzNDMiLCAiYXVkIjogIm15aW5mbyIsICJuYmYiOiAxNTA1ODkwNzUxLCAic2NvcGUiOiBbICJlZHVsZXZlbCIsICJob3VzaW5ndHlwZSIsICJyYWNlIiwgInJlZ2FkZCIsICJzZXgiLCAiaGRidHlwZSIsICJtb2JpbGVubyIsICJjcGZiYWxhbmNlcyIsICJoYW55dXBpbnlpbm5hbWUiLCAibWFycmllZG5hbWUiLCAiaGFueXVwaW55aW5hbGlhc25hbWUiLCAiYXNzZXNzYWJsZWluY29tZSIsICJtYXJpdGFsIiwgImFsaWFzbmFtZSIsICJuYXRpb25hbGl0eSIsICJkb2IiLCAibmFtZSIsICJjcGZjb250cmlidXRpb25zIiwgImVtYWlsIiBdLCAicmVhbG0iOiAiL215aW5mbyIsICJleHAiOiAxNTA1ODk0MzUxLCAiaWF0IjogMTUwNTg5MDc1MSwgImV4cGlyZXNfaW4iOiAzNjAwMDAwLCAianRpIjogIjI2MmM3ODk5LWY4YmQtNDVlOC05Mzc1LWRmYTY5YWUwNTA3YSIgfQ.maD5lnrRA84hm2Lz5gdUlM6ZVSsYxYlWodtMTesleDXJrD3hDeUVbmHGumeH4XogtmYacCWKh3geY5iItK4WLr_ft5oFzvXilWrud7zahFOR5QuOxhALzl8d1erDN4jCQfbT6xq98B7nRCG9JAB1qvEvnSGQLGSWxH3j4IxE5Jp5iP-3AzshXub-8JukAqnWZLiQsoJCUu8GBg0RfG85wRKwImPmnPyCoAwqTv2MlqhZQr5oXkkeRrqITkZQME3sFiqZmnExjHcml8Y__5h3FNvJSFdnnZSDW0471wBpYM9-jK7WdBR9rKS68sxdNa85y-TQ7YXcb5AHYPro9GGY6w\",\r\n\"code\": \"322c89af-3921-9f8e-1ab3-87f8de0bc8ce\"\r\n },\r\n \"info\": {\r\n \"messageCode\": 850301,\r\n \"message\": \"Arguments Error\",\r\n \"fieldInfoList\": [\r\n \ {\r\n \"field\": \"code\",\r\n \"message\": \"Authentication code verification failed\"\r\n }\r\n ]\r\n }\r\n\r\n}" AuthoriseResponse: description: "" type: object properties: returnCode: type: integer format: int32 data: type: object properties: url: type: string state: type: string info: type: object properties: messageCode: type: number message: type: string fieldInfoList: type: array items: properties: field: type: string message: type: string type: object example: "{\r\n \"returnCode\": 10,\r\n \"data\": {\r\n\"url\": \"https://stg-saml.singpass.gov.sg/FIM/sps/SingpassIDPFed/saml20/logininitial?client_id=a1234b5c-1234-abcd-efgh-a1234b5cdef&scope=GSTReturnsSub+GSTTransListSub&redirect_uri=http://www.iras.gov.sg/callback&state=390b25fa-4427-4b10-9ae2-34d6e0cd91a1\",\r\n\"state\": \"390b25fa-4427-4b10-9ae2-34d6e0cd91a1\"\r\n },\r\n \"info\": {\r\n \"messageCode\": 850301,\r\n \"message\": \"Arguments Error\",\r\n \"fieldInfoList\": [\r\n \ {\r\n \"field\": \"callback_url\",\r\n \"message\": \"The callback_url specified is not registered\"\r\n }\r\n ]\r\n }\r\n\r\n}" x-ibm-endpoints: - endpointUrl: https://apiservices.iras.gov.sg/iras/prod description: Custom Gateway API Endpoint type: - production - development ...