getSSOUserInfo

Given a valid Authorization Code following a successful social login (Google, Facebook, Apple etc), returns the Username, Email, Firstname, and Lastname which can then be used to register a new user choosing to use social logins to access myINTERACT.

Request

POST /rest/user/sso-user-info

Parameters

Parameter	Type	Required	Description
version	String	Yes	Version of API to call. Currently 1.
deviceType	String	Yes	One of the existing device types - iPad, iPhone, Desktop, Android Tablet, Android Phone, or Rego (for custom rego pages).
code	String	Yes	Authorization Code returned via redirect_url post a successful SSO login.

e.g. if a user is directed to Google and is successfully authenticated, a code (Authorization Code) is passed back to the caller via the redirect_url sent in the request. This code is then passed into this API.

Response

200 OK

SAMPLE RESPONSE:

Response Fields

Field	Type	Description
userFirstname	String	User's first name.
userLastname	String	User's last name.
refreshToken	String	The refresh_token returned using AuthorizationCode.
accessToken	String	The access_token returned using AuthorizationCode.
username	String	The username as stored in the AWS Cognito IdP.
userEmail	String	The user's email address.
providerName	String	The name of the SSO provider as configured in the GLOBAL_ID table e.g. GOOGLE, APPLE, FACEBOOK.
registered	String	Flag to indicate whether a user is registered in myINTERACT.

{
    "userFirstname": "Aaron",
    "userLastname": "McMullen",
    "refreshToken": "eyJjdHkiOiJKV1QiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiUlNBLU9BRVAifQ.QJQivETZgJgiHWvnE9yM8sSc5d6Z5USI4lYu19MEtbeNrbETVTABKml_4M4Q6uLCrnIfeufqUoigyH1wca2e3GLgYTYsppt1XXrxcpyCqApMxOozn5y70shZfsCUI21IHpiuP5jqMmLMQwpXnelWh_hTuqcn6RQcWitiiNGpb5vnrA6hjMDQv__fwiA5Eu6agtbqXuZnmLDHsukwiRg2g6IlkBXtOaCfdEa6IVWaTMbW9QhQx-E7UzGMfOn9PPgk-RJvDLssphRf1af1StQc-QpR8lC0SxoPANWV_CwNx7876sVRd0pKBJyfebBJaGRQiWlZOZPN4fhbAN8gX4yJUA.EXGwNbA_NZYCwKhD.-WofIYupUL9eXUin1g34xPV1ABEeJWw4m261UXfqUxH5d9EYnt3ED5LM6wfEZ3Nz-M8H2ZkBhkbuXp2bj8XJqrQ-3wMdTcy8AfzSOEDRIOikwDaIVXIqR03mZd9Webd_2lBnjHAisSTrNtZT-orD42xaWhShDXntVuScZvOSmBqiX4zQQuCu20_MiLuHBsk_yZiXxUHD_fpVkkYkOEc_6MN7S5bCoOaz7FGIdbAecsouRopS3aA9MhpxrPe6Jj7HDaLOViPhHG7x1ZmAum7SZ3rTNK93HnHJsXys96FBQQ53zibQBeeURxCFRPQ2WVso59zojrVCjMfd-XIbxc0J-4ySANX41Y7WEKC8I_7CAdxyXAtjoSAUjrHhz3v3k9-fxFUUznEs76JJcIYP9fw8Ds4LBfFd-LqOBcQN2L8wWjT-UwVSWVNG2CKySMGlWYqRvXoLIE8o2LNZtMMIkM71-75VdnQILhYTPHLKMRtMZ8KdpcJaN9Mbms0U9PK1Cg7pyUI6t4LJNIuJ8yszmYeVfQGIbzFLpke0s0lFQyXU2hG91AtLkBCSYSGjRYfDbgLPmv9Han3rWx_sCSiYXRz7rXm2BPr36Em9jT03c-Sw_NSkhfIKdKtGjyJKWbhcQdr2JyOKOuT5TOOMqBummB39EyKwvRXnQMSOp20kNdMJ2xmtIPNDQcPHZooZm7Aa6_zfHvyYc5MrBP_6XP-CbVUlulTfhNPh_UghYa9yLXr8XHcYLRoPieQNxtrOkqaEpByTZaZtyTQs0ddU5lWufl4n43gdZo4I6KRmCnAhxLPBfEqr44qinnnwW5CQkHBX9HYONEq9hG2vH3bqwKiKiKC7fOBUgFIRS7Cz2PpMGd8iQAdgK8_WQfdYUY1vN_xcTsVupZvYChtjtrmToyJuGazs10g6vWnDdvTWmUeWM7XNKIq20iKZPVIyMnjdMN1EBW-F-AnD90i_hwxsqKRvLl-XwICJx99ZTLHIZbm6PMbJjG_uRdrHVrRzO052pWEYjZRqEFL84vL51-SHckhAt4-G5IAVpN5c-7eL8nzBz0PN5cYvfz3Bb053H2yWowe94X9QusnwFdTGyG8eOQD8NR5-IMkxvv8Ybnf-yIgoxXerLjpeSC2jFNDrMOtRiLcVWZOHSiuJbGMAAERAe2oHo-J91vx-XF-i2JhQziJk_HKC00b4HxVZ0h0O3R3bmHgPJD1iqSmeiuGm9_ZsZDWzKT5dmuUj2jmvysF1i7nZw8yJupSIs81xk-FUv-z1ki6kUHlJIS_D-Hl0yPKmegYe6XOuJKCQ8rENSuWDTmSK9we1cg.Ko0C_gxIOXWyKciV4kdnyw",
    "accessToken": "eyJraWQiOiJQWStXMWNxb0hVWnFMUHlxT0dHMXhpQzBoc2pqNnA1NGxITTF1V0NSWStJPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiJjMTMyNmU4MS00YjMxLTQyZGUtOWNjMi01MWIzMTg3NDM0ZGUiLCJjb2duaXRvOmdyb3VwcyI6WyJhcC1zb3V0aGVhc3QtMl9yakxhdkxvWjFfR29vZ2xlIl0sImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5hcC1zb3V0aGVhc3QtMi5hbWF6b25hd3MuY29tXC9hcC1zb3V0aGVhc3QtMl9yakxhdkxvWjEiLCJ2ZXJzaW9uIjoyLCJjbGllbnRfaWQiOiI1azJqa2dyaGs0NTR1bDA1ODBocTIwbXRwZiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiYXdzLmNvZ25pdG8uc2lnbmluLnVzZXIuYWRtaW4gcGhvbmUgb3BlbmlkIHByb2ZpbGUgZW1haWwiLCJhdXRoX3RpbWUiOjE3MDc5NjgyMzAsImV4cCI6MTcwNzk3MTgzMCwiaWF0IjoxNzA3OTY4MjMwLCJqdGkiOiJkMDBhMjdkOS0xNTE4LTQ1ZjItOGIyOS0xYTMzZWUzM2ZhYmMiLCJ1c2VybmFtZSI6Ikdvb2dsZV8xMDM3MTA4OTA3ODkyNzg2NTc1MzcifQ.vsGHT1vEeWxm8KRkyri1RBRhVx_1hiZ419Bz5BsGWAYrgQoHOyT8-mbBX-ShTQ3I-SIsixb-94xSz8hxktNb5Cv-WvLN2BvcSTTYcXPsZD1KfRh8DuU8uSOKfZSNhdCOCZUqhXaLSz7M_oWoWPzLTuMkIQiKIRI1oNxl6P0oSFErQMU4kzGyMKDj03nd5tq77nZI1ZOiVDSrjnI67Yqka3pR2D4XcgorAWtlywRXoFkh_ld7rJy7xqAVZMdFpavRtY1QSTBnsRTCeyC2SrFfO4BR8pq8ReFIkG9qD6fWz82swOYP4WxWrAwMuRppXo2ymxMJs9gEQk8NqytX6Zw7Xg",
    "userEmail": "aaron@interact.technology",
    "username": "Google_103710890789278657537",
    "registered": false
}

Errors

Exception	Description
InvalidParameterException	See Error Definitions
UnsupportedVersionException	See Error Definitions
CognitoAuthorizationCodeException	See Error Definitions
CognitoServiceException	See Error Definitions