Differences

This shows you the differences between two versions of the page.

--- vendors:cisco:uc:ucce:finesse:js-api [2025/10/29 10:03] – created gerardorourke
+++ vendors:cisco:uc:ucce:finesse:js-api [2025/10/29 10:10] (current) – [An SSO User] gerardorourke
@@ Line 1: / Line 1: @@
 ===== Finesse JavaScript API =====
-=====Auth Examples =====
+=====Auth API Examples =====
-==== An SSO User ====
+Reference: https://developer.cisco.com/docs/finesse/utilities/#getauthheaderstringconfigobj
+==== A non SSO User ====
 <code>
-Oct 29 2025 09:38:29.785 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): getToken(): eyAbCdEfGhKV1QiLCJhbGciOiJSUzI1NiJ9.eyabcdefghijYS1jY3RpZGEtMDAyLmFkLmFpYi5wcmkiLCJzdWIiOiJ7XCJzY29wZVwiOltcImNjY19vbnByZW1fYXBwc1wiXSxcInJ0XCI6XCI4M2MzNTk4ZDZmZjNkZGRkMzczOWVlNzU0MWNlMzgwNGM5NGFiZDEwXCIsXCJ1c2VyX2lkXCI6XCI5MTI2MlwiLFwicmVhbG1cIjpcImFpYi5pZVwiLFwidXBuXCI6XCI5MTI2MkBhaWIuaWVcIixcImlkc19pZFwiOlwidmEtY2N0aWRhLTAwMi5hZC5haWIucHJpXCIsXCJjbGllbnRfaWRcIjpcIjY1MTM5ZjA0NTg0NmFjNjVlM2QwYzQ0NDBlOWYxOTA4YThiNTY5MmJcIixcInRva2VuXCI6XCJlZGMwNzZmOWQ3ZGY1MTQxMjk3YzRiNDRiNmEyYjljOGMwMzdkYzVkXCIsXCJleHBpcnlcIjoxNzYxNzM0MzA2NzY3LFwidXNhZ2VcIjpcImFjY2Vzc1wiLFwidmVyXCI6XCIxLjBcIn0iLCJleHAiOjE3NjE3MzQzMDYsImlhdCI6MTc2MTczMDcwNiwianRpIjoiZWRjMDc2ZjlkN2RmNTE0MTI5N2M0YjQ0YjZhMmI5YzhjMDM3ZGM1ZCJ9.JswLahzS9aq6dqbOxOXD2ljqZFyAMHXfmewbed5aAhX9b9oI2hGwGWxN9W9Ud4xWIJZIesK3zrJj5qTBPqjTHBMa9X9zCCTFRV7nDxc4jMBvEtmZ8UEMKdWL-XueOOv-xtqWEquSHHmz7eww0b39GLBRDeq6100HB1ioJCd4L4DMbjBiDgZCGGlYzLOUtbM0vUTYQlmy8yBKqjA-QRFNu7I4-TUdK26g4MILcJ163jZBjZUwz1rwLWPuB5-nr2XJ7cUCcZjSJXvO3abcdefghijkLMNOPQRSTUVWxyz8tcJq2yadplin9T_K6x7MpS4rnrx9-ETD5RzN1vVQnVxPoQ
+getToken(): undefined
-Oct 29 2025 09:38:29.786 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): getUserAuthString(): OTEyNjI6
-Oct 29 2025 09:38:29.786 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): getAuthHeaderString(finesse.gadget.Config): Bearer eyAbCdEfGhKV1QiLCJhbGciOiJSUzI1NiJ9.eyabcdefghijYS1jY3RpZGEtMDAyLmFkLmFpYi5wcmkiLCJzdWIiOiJ7XCJzY29wZVwiOltcImNjY19vbnByZW1fYXBwc1wiXSxcInJ0XCI6XCI4M2MzNTk4ZDZmZjNkZGRkMzczOWVlNzU0MWNlMzgwNGM5NGFiZDEwXCIsXCJ1c2VyX2lkXCI6XCI5MTI2MlwiLFwicmVhbG1cIjpcImFpYi5pZVwiLFwidXBuXCI6XCI5MTI2MkBhaWIuaWVcIixcImlkc19pZFwiOlwidmEtY2N0aWRhLTAwMi5hZC5haWIucHJpXCIsXCJjbGllbnRfaWRcIjpcIjY1MTM5ZjA0NTg0NmFjNjVlM2QwYzQ0NDBlOWYxOTA4YThiNTY5MmJcIixcInRva2VuXCI6XCJlZGMwNzZmOWQ3ZGY1MTQxMjk3YzRiNDRiNmEyYjljOGMwMzdkYzVkXCIsXCJleHBpcnlcIjoxNzYxNzM0MzA2NzY3LFwidXNhZ2VcIjpcImFjY2Vzc1wiLFwidmVyXCI6XCIxLjBcIn0iLCJleHAiOjE3NjE3MzQzMDYsImlhdCI6MTc2MTczMDcwNiwianRpIjoiZWRjMDc2ZjlkN2RmNTE0MTI5N2M0YjQ0YjZhMmI5YzhjMDM3ZGM1ZCJ9.JswLahzS9aq6dqbOxOXD2ljqZFyAMHXfmewbed5aAhX9b9oI2hGwGWxN9W9Ud4xWIJZIesK3zrJj5qTBPqjTHBMa9X9zCCTFRV7nDxc4jMBvEtmZ8UEMKdWL-XueOOv-xtqWEquSHHmz7eww0b39GLBRDeq6100HB1ioJCd4L4DMbjBiDgZCGGlYzLOUtbM0vUTYQlmy8yBKqjA-QRFNu7I4-TUdK26g4MILcJ163jZBjZUwz1rwLWPuB5-nr2XJ7cUCcZjSJXvO3abcdefghijkLMNOPQRSTUVWxyz8tcJq2yadplin9T_K6x7MpS4rnrx9-ETD5RzN1vVQnVxPoQ
+getUserAuthString(): ZmFrZXVzZXI6ZmFrZXBhc3N3b3Jk
-Oct 29 2025 09:38:29.786 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): gerAuthModes(): {"SSO":"SSO","NONSSO":"NON_SSO","HYBRID":"HYBRID"}
-Oct 29 2025 09:38:29.786 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): 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]"}
+getAuthHeaderString(finesse.gadget.Config): Basic ZmFrZXVzZXI6ZmFrZXBhc3N3b3Jk
+getAuthModes(): {"SSO":"SSO","NONSSO":"NON_SSO","HYBRID":"HYBRID"}
+getAuthTokenObj(): null
 </code>
+==== 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.
-==== A non SSO User ====
 <code>
-Oct 29 2025 09:51:51.316 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): getToken(): undefined
+getToken(): eyAbCdEfGhKV1QiLCJhbGciOiJSUzI1NiJ9.eyabcdefghijYS1jY3RpZGEtMDAyLmFkLmFpYi5wcmkiLCJzdWIiOiJ7XCJzY29wZVwiOltcImNjY19vbnByZW1fYXBwc1wiXSxcInJ0XCI6XCI4M2MzNTk4ZDZmZjNkZGRkMzczOWVlNzU0MWNlMzgwNGM5NGFiZDEwXCIsXCJ1c2VyX2lkXCI6XCI5MTI2MlwiLFwicmVhbG1cIjpcImFpYi5pZVwiLFwidXBuXCI6XCI5MTI2MkBhaWIuaWVcIixcImlkc19pZFwiOlwidmEtY2N0aWRhLTAwMi5hZC5haWIucHJpXCIsXCJjbGllbnRfaWRcIjpcIjY1MTM5ZjA0NTg0NmFjNjVlM2QwYzQ0NDBlOWYxOTA4YThiNTY5MmJcIixcInRva2VuXCI6XCJlZGMwNzZmOWQ3ZGY1MTQxMjk3YzRiNDRiNmEyYjljOGMwMzdkYzVkXCIsXCJleHBpcnlcIjoxNzYxNzM0MzA2NzY3LFwidXNhZ2VcIjpcImFjY2Vzc1wiLFwidmVyXCI6XCIxLjBcIn0iLCJleHAiOjE3NjE3MzQzMDYsImlhdCI6MTc2MTczMDcwNiwianRpIjoiZWRjMDc2ZjlkN2RmNTE0MTI5N2M0YjQ0YjZhMmI5YzhjMDM3ZGM1ZCJ9.JswLahzS9aq6dqbOxOXD2ljqZFyAMHXfmewbed5aAhX9b9oI2hGwGWxN9W9Ud4xWIJZIesK3zrJj5qTBPqjTHBMa9X9zCCTFRV7nDxc4jMBvEtmZ8UEMKdWL-XueOOv-xtqWEquSHHmz7eww0b39GLBRDeq6100HB1ioJCd4L4DMbjBiDgZCGGlYzLOUtbM0vUTYQlmy8yBKqjA-QRFNu7I4-TUdK26g4MILcJ163jZBjZUwz1rwLWPuB5-nr2XJ7cUCcZjSJXvO3abcdefghijkLMNOPQRSTUVWxyz8tcJq2yadplin9T_K6x7MpS4rnrx9-ETD5RzN1vVQnVxPoQ
-Oct 29 2025 09:51:51.317 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): getUserAuthString(): ZmFrZXVzZXI6ZmFrZXBhc3N3b3Jk
-Oct 29 2025 09:51:51.317 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): getAuthHeaderString(finesse.gadget.Config): Basic ZmFrZXVzZXI6ZmFrZXBhc3N3b3Jk
+getUserAuthString(): NTEwMDE6
-Oct 29 2025 09:51:51.317 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): gerAuthModes(): {"SSO":"SSO","NONSSO":"NON_SSO","HYBRID":"HYBRID"}
-Oct 29 2025 09:51:51.317 +0000: HeadlessGetUserAuthGadget : handleTokenRequest(): getAuthTokenObj(): null
+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]"}
 </code>