REST API Details

  1. Request type: POST
  2. URL according to environment being used - https://api.lyearn.com/auth/sso
  3. Compulsory body parameter(s):
    1. type - JWT (all letters capital)
    2. appId - provided by Lyearn team
    3. payload - signed and encoded on your end with mutually shared JWT secret (secret provided by Lyearn Team)

Note: Please fill all <> with relevant data

Sample cURL request

curl --location --request POST '<https://api.lyearn.com/auth/sso>' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "type": "JWT",
    "appId": "<YOUR_APP_ID_HERE>",
		"host": "<your-subdomain>.lyearn.com"
    "payload": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyRGV0YWlscyI6eyJmaXJzdE5hbWUiOiI8VVNFUl9GSVJTVF9OQU1FPiIsImxhc3ROYW1lIjoiPFVTRVJfTEFTVF9OQU1FPiIsImVtYWlsIjoiPFVTRVJfRU1BSUw-IiwicGFzc3dvcmQiOiI8VVNFUl9QQVNTV09SRD4iLCJ0YWdzIjp7IjxUQUdTX05BTUU-IjoiVEFHX1ZBTFVFIn19LCJyZWRpcmVjdFVSTCI6IjxPUFRJT05BTF9VUkw-In0.QU7l-hBj-LssKgGhONwslcUtd5fYZ1Eopx3eYeMuNDg"
}'

Payload format

RAW - before signing and encoding with mutually shared JWT secret

{
    "userDetails": {         // COMPULSORY
        "firstName": "",     // user's first name
        "lastName": "",      // user's last name
        "email": "",         // user's email as in your platform   
    }
}