Finesse JavaScript API
Auth API Examples
A non SSO User
getToken(): undefined
getUserAuthString(): ZmFrZXVzZXI6ZmFrZXBhc3N3b3Jk
getAuthHeaderString(finesse.gadget.Config): Basic ZmFrZXVzZXI6ZmFrZXBhc3N3b3Jk
getAuthModes(): {"SSO":"SSO","NONSSO":"NON_SSO","HYBRID":"HYBRID"}
getAuthTokenObj(): null
An SSO User
Note the AuthString value is the Base64 encoding of the “username” and a “:”, e.g. “51001:” i.e. no password since its SSO.
getToken(): eyAbCdEfGhKV1QiLCJhbGciOiJSUzI1NiJ9.eyabcdefghijYS1jY3RpZGEtMDAyLmFkLmFpYi5wcmkiLCJzdWIiOiJ7XCJzY29wZVwiOltcImNjY19vbnByZW1fYXBwc1wiXSxcInJ0XCI6XCI4M2MzNTk4ZDZmZjNkZGRkMzczOWVlNzU0MWNlMzgwNGM5NGFiZDEwXCIsXCJ1c2VyX2lkXCI6XCI5MTI2MlwiLFwicmVhbG1cIjpcImFpYi5pZVwiLFwidXBuXCI6XCI5MTI2MkBhaWIuaWVcIixcImlkc19pZFwiOlwidmEtY2N0aWRhLTAwMi5hZC5haWIucHJpXCIsXCJjbGllbnRfaWRcIjpcIjY1MTM5ZjA0NTg0NmFjNjVlM2QwYzQ0NDBlOWYxOTA4YThiNTY5MmJcIixcInRva2VuXCI6XCJlZGMwNzZmOWQ3ZGY1MTQxMjk3YzRiNDRiNmEyYjljOGMwMzdkYzVkXCIsXCJleHBpcnlcIjoxNzYxNzM0MzA2NzY3LFwidXNhZ2VcIjpcImFjY2Vzc1wiLFwidmVyXCI6XCIxLjBcIn0iLCJleHAiOjE3NjE3MzQzMDYsImlhdCI6MTc2MTczMDcwNiwianRpIjoiZWRjMDc2ZjlkN2RmNTE0MTI5N2M0YjQ0YjZhMmI5YzhjMDM3ZGM1ZCJ9.JswLahzS9aq6dqbOxOXD2ljqZFyAMHXfmewbed5aAhX9b9oI2hGwGWxN9W9Ud4xWIJZIesK3zrJj5qTBPqjTHBMa9X9zCCTFRV7nDxc4jMBvEtmZ8UEMKdWL-XueOOv-xtqWEquSHHmz7eww0b39GLBRDeq6100HB1ioJCd4L4DMbjBiDgZCGGlYzLOUtbM0vUTYQlmy8yBKqjA-QRFNu7I4-TUdK26g4MILcJ163jZBjZUwz1rwLWPuB5-nr2XJ7cUCcZjSJXvO3abcdefghijkLMNOPQRSTUVWxyz8tcJq2yadplin9T_K6x7MpS4rnrx9-ETD5RzN1vVQnVxPoQ
getUserAuthString(): NTEwMDE6
getAuthHeaderString(finesse.gadget.Config): Bearer eyAbCdEfGhKV1QiLCJhbGciOiJSUzI1NiJ9.eyabcdefghijYS1jY3RpZGEtMDAyLmFkLmFpYi5wcmkiLCJzdWIiOiJ7XCJzY29wZVwiOltcImNjY19vbnByZW1fYXBwc1wiXSxcInJ0XCI6XCI4M2MzNTk4ZDZmZjNkZGRkMzczOWVlNzU0MWNlMzgwNGM5NGFiZDEwXCIsXCJ1c2VyX2lkXCI6XCI5MTI2MlwiLFwicmVhbG1cIjpcImFpYi5pZVwiLFwidXBuXCI6XCI5MTI2MkBhaWIuaWVcIixcImlkc19pZFwiOlwidmEtY2N0aWRhLTAwMi5hZC5haWIucHJpXCIsXCJjbGllbnRfaWRcIjpcIjY1MTM5ZjA0NTg0NmFjNjVlM2QwYzQ0NDBlOWYxOTA4YThiNTY5MmJcIixcInRva2VuXCI6XCJlZGMwNzZmOWQ3ZGY1MTQxMjk3YzRiNDRiNmEyYjljOGMwMzdkYzVkXCIsXCJleHBpcnlcIjoxNzYxNzM0MzA2NzY3LFwidXNhZ2VcIjpcImFjY2Vzc1wiLFwidmVyXCI6XCIxLjBcIn0iLCJleHAiOjE3NjE3MzQzMDYsImlhdCI6MTc2MTczMDcwNiwianRpIjoiZWRjMDc2ZjlkN2RmNTE0MTI5N2M0YjQ0YjZhMmI5YzhjMDM3ZGM1ZCJ9.JswLahzS9aq6dqbOxOXD2ljqZFyAMHXfmewbed5aAhX9b9oI2hGwGWxN9W9Ud4xWIJZIesK3zrJj5qTBPqjTHBMa9X9zCCTFRV7nDxc4jMBvEtmZ8UEMKdWL-XueOOv-xtqWEquSHHmz7eww0b39GLBRDeq6100HB1ioJCd4L4DMbjBiDgZCGGlYzLOUtbM0vUTYQlmy8yBKqjA-QRFNu7I4-TUdK26g4MILcJ163jZBjZUwz1rwLWPuB5-nr2XJ7cUCcZjSJXvO3abcdefghijkLMNOPQRSTUVWxyz8tcJq2yadplin9T_K6x7MpS4rnrx9-ETD5RzN1vVQnVxPoQ
getAuthModes(): {"SSO":"SSO","NONSSO":"NON_SSO","HYBRID":"HYBRID"}
getAuthTokenObj(): {"token":"eyAbCdEfGhKV1QiLCJhbGciOiJSUzI1NiJ9.eyabcdefghijYS1jY3RpZGEtMDAyLmFkLmFpYi5wcmkiLCJzdWIiOiJ7XCJzY29wZVwiOltcImNjY19vbnByZW1fYXBwc1wiXSxcInJ0XCI6XCI4M2MzNTk4ZDZmZjNkZGRkMzczOWVlNzU0MWNlMzgwNGM5NGFiZDEwXCIsXCJ1c2VyX2lkXCI6XCI5MTI2MlwiLFwicmVhbG1cIjpcImFpYi5pZVwiLFwidXBuXCI6XCI5MTI2MkBhaWIuaWVcIixcImlkc19pZFwiOlwidmEtY2N0aWRhLTAwMi5hZC5haWIucHJpXCIsXCJjbGllbnRfaWRcIjpcIjY1MTM5ZjA0NTg0NmFjNjVlM2QwYzQ0NDBlOWYxOTA4YThiNTY5MmJcIixcInRva2VuXCI6XCJlZGMwNzZmOWQ3ZGY1MTQxMjk3YzRiNDRiNmEyYjljOGMwMzdkYzVkXCIsXCJleHBpcnlcIjoxNzYxNzM0MzA2NzY3LFwidXNhZ2VcIjpcImFjY2Vzc1wiLFwidmVyXCI6XCIxLjBcIn0iLCJleHAiOjE3NjE3MzQzMDYsImlhdCI6MTc2MTczMDcwNiwianRpIjoiZWRjMDc2ZjlkN2RmNTE0MTI5N2M0YjQ0YjZhMmI5YzhjMDM3ZGM1ZCJ9.JswLahzS9aq6dqbOxOXD2ljqZFyAMHXfmewbed5aAhX9b9oI2hGwGWxN9W9Ud4xWIJZIesK3zrJj5qTBPqjTHBMa9X9zCCTFRV7nDxc4jMBvEtmZ8UEMKdWL-XueOOv-xtqWEquSHHmz7eww0b39GLBRDeq6100HB1ioJCd4L4DMbjBiDgZCGGlYzLOUtbM0vUTYQlmy8yBKqjA-QRFNu7I4-TUdK26g4MILcJ163jZBjZUwz1rwLWPuB5-nr2XJ7cUCcZjSJXvO3abcdefghijkLMNOPQRSTUVWxyz8tcJq2yadplin9T_K6x7MpS4rnrx9-ETD5RzN1vVQnVxPoQ","expires_in":3600,"user_id":"51001","realm":"mydomain.com","user_principal":"[email protected]"}