new Identity<
Source:
en
Source:
logSetting
Source:
hasSession<
Source:
(async) isL
Source:
Source:
(async) is
Source:
(async) getUse
Source:
Returns:
(async) getUserId() → {Promise.<string>}
-
logSetting
Source:
hasSession<
Source:
(async) isL
Source:
Source:
(async) is
Source:
(async) getUse
Source:
Returns:
(async) getUserId() → {Promise.<string>}
-
(async) isL
Source:
Source:
(async) is
Source:
(async) getUse
Source:
Returns:
(async) getUserId() → {Promise.<string>}
-
(async) is
Source:
(async) getUse
Source:
Returns:
(async) getUserId() → {Promise.<string>}
-
Returns:
(async) getUserId() → {Promise.<string>}
-In Schibsted account, there are two ways of identifying a user; the userId and the
-uuid. There are reasons for them both existing. The userId is a numeric identifier, but
+
In Schibsted account, there are multiple ways of identifying a user; the userId,
+uuid and externalId used for identifying a user-merchant pair (see Identity#getExternalId).
+There are reasons for them all to exist. The userId is a numeric identifier, but
since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
duplicates. The userId was introduced early, so many sites still need to use them for
legacy reasons. The uuid is universally unique, and so — if we could disregard a lot of
@@ -1532,7 +1533,7 @@
(async) getU
Source:
Returns:
+ (async) getExternalId() → {Promise.<string>}
+
+
+
Retrieves the external identifier (externalId) for the authenticated user.
In Schibsted Account there are multiple ways of identifying users, however for integrations with
+third-parties it's recommended to use externalId as it does not disclose
+any critical data whilst allowing for user identification.
externalId is merchant-scoped using a pairwise identifier (pairId),
+meaning the same user's ID will differ between merchants.
+Additionally, this identifier is bound to the external party provided as argument.
-
+
+
+
- Source: +
- + identity.js, line 638 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+This function calls Identity#hasSession internally and thus has the side
+effect that it might perform an auto-login on the user
Throws:
+-
+
-
+
+
-
+
-
+ ++
If the
+pairIdis missing in user session.
+
+ - +
- + Type + +
- + +SDKError + + + +
-
+
+
+ -
+
-
+
+
-
+
-
+ ++
If the
+externalPartyis not defined
+
+ - +
- + Type + +
- + +SDKError + + + +
-
+
+ -
+
Returns:
+ + +
+
+
+
+
+The merchant- and 3rd-party-specific externalId
-
+
- + Type + +
- + +Promise.<string> + + + +
(async) getUserSDRN() → {Promise.<string>}
+ + +Enables brands to programmatically get the current the SDRN based on the user's session.
+ + + + + +-
+
+
+
- Source: +
- + identity.js, line 680 +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+This function calls Identity#hasSession internally and thus has the side
+effect that it might perform an auto-login on the user
Throws:
+ + + +-
+
-
+ ++
If the SDRN is missing in user session object.
+
+
+ - +
- + Type + +
- + +SDKError + + + +
-
+
Returns:
+ + + + +-
+
- + Type + +
- + +Promise.<string> + + + +
(async) getUserUuid() → {Promise.<string>}
@@ -1675,7 +1981,7 @@(async) ge
Source:
(async) Source:
loginSource:
(async) getSpI
Source:
logoutSource:
loginUrlSource:
logoutUrlSource:
accountUrl<
Source:
phonesUrlSource:
(as
Source:
error
Source:
login
Source:
logout
Source:
userChange
Source:
sessionChange
Source:
notLoggedin
Source:
sessionInit
Source:
statusChange
Source:
simplifiedLoginOpened
Source:
simplifiedLoginCancelledSource:
simplifiedLoginCancelled
diff --git a/Monetization.html b/Monetization.html
index 9e242800..b8f53381 100644
--- a/Monetization.html
+++ b/Monetization.html
@@ -23,7 +23,7 @@
@@ -1211,7 +1211,7 @@ Returns:
diff --git a/Payment.html b/Payment.html
index 9bf8615d..9e5e1e0e 100644
--- a/Payment.html
+++ b/Payment.html
@@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@ Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html
index abb7522b..feed752c 100644
--- a/RESTClient.js.html
+++ b/RESTClient.js.html
@@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@ RESTClient.js
diff --git a/config.js.html b/config.js.html
index 80e3f393..2cc41479 100644
--- a/config.js.html
+++ b/config.js.html
@@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@ config.js
diff --git a/global.html b/global.html
index 8012d66f..35ff4026 100644
--- a/global.html
+++ b/global.html
@@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@ Properties:
+
+
+
+ pairId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sdrn
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ HasSessionFailureResponse
Source:
SimplifiedLoginData
Source:
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
loginSource:
(async) getSpI
Source:
logoutSource:
loginUrlSource:
logoutUrlSource:
accountUrl<
Source:
phonesUrlSource:
(as
Source:
error
Source:
login
Source:
logout
Source:
userChange
Source:
sessionChange
Source:
notLoggedin
Source:
sessionInit
Source:
statusChange
Source:
simplifiedLoginOpened
Source:
simplifiedLoginCancelledSource:
simplifiedLoginCancelled
diff --git a/Monetization.html b/Monetization.html
index 9e242800..b8f53381 100644
--- a/Monetization.html
+++ b/Monetization.html
@@ -23,7 +23,7 @@
@@ -1211,7 +1211,7 @@ Returns:
diff --git a/Payment.html b/Payment.html
index 9bf8615d..9e5e1e0e 100644
--- a/Payment.html
+++ b/Payment.html
@@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@ Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html
index abb7522b..feed752c 100644
--- a/RESTClient.js.html
+++ b/RESTClient.js.html
@@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@ RESTClient.js
diff --git a/config.js.html b/config.js.html
index 80e3f393..2cc41479 100644
--- a/config.js.html
+++ b/config.js.html
@@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@ config.js
diff --git a/global.html b/global.html
index 8012d66f..35ff4026 100644
--- a/global.html
+++ b/global.html
@@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@ Properties:
+
+
+
+ pairId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sdrn
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ HasSessionFailureResponse
Source:
SimplifiedLoginData
Source:
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
logoutSource:
loginUrlSource:
logoutUrlSource:
accountUrl<
Source:
phonesUrlSource:
(as
Source:
error
Source:
login
Source:
logout
Source:
userChange
Source:
sessionChange
Source:
notLoggedin
Source:
sessionInit
Source:
statusChange
Source:
simplifiedLoginOpened
Source:
simplifiedLoginCancelledSource:
simplifiedLoginCancelled
diff --git a/Monetization.html b/Monetization.html
index 9e242800..b8f53381 100644
--- a/Monetization.html
+++ b/Monetization.html
@@ -23,7 +23,7 @@
@@ -1211,7 +1211,7 @@ Returns:
diff --git a/Payment.html b/Payment.html
index 9bf8615d..9e5e1e0e 100644
--- a/Payment.html
+++ b/Payment.html
@@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@ Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html
index abb7522b..feed752c 100644
--- a/RESTClient.js.html
+++ b/RESTClient.js.html
@@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@ RESTClient.js
diff --git a/config.js.html b/config.js.html
index 80e3f393..2cc41479 100644
--- a/config.js.html
+++ b/config.js.html
@@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@ config.js
diff --git a/global.html b/global.html
index 8012d66f..35ff4026 100644
--- a/global.html
+++ b/global.html
@@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@ Properties:
+
+
+
+ pairId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sdrn
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ HasSessionFailureResponse
Source:
SimplifiedLoginData
Source:
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
logoutUrlSource:
accountUrl<
Source:
phonesUrlSource:
(as
Source:
error
Source:
login
Source:
logout
Source:
userChange
Source:
sessionChange
Source:
notLoggedin
Source:
sessionInit
Source:
statusChange
Source:
simplifiedLoginOpened
Source:
simplifiedLoginCancelledSource:
simplifiedLoginCancelled
diff --git a/Monetization.html b/Monetization.html
index 9e242800..b8f53381 100644
--- a/Monetization.html
+++ b/Monetization.html
@@ -23,7 +23,7 @@
@@ -1211,7 +1211,7 @@ Returns:
diff --git a/Payment.html b/Payment.html
index 9bf8615d..9e5e1e0e 100644
--- a/Payment.html
+++ b/Payment.html
@@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@ Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html
index abb7522b..feed752c 100644
--- a/RESTClient.js.html
+++ b/RESTClient.js.html
@@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@ RESTClient.js
diff --git a/config.js.html b/config.js.html
index 80e3f393..2cc41479 100644
--- a/config.js.html
+++ b/config.js.html
@@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@ config.js
diff --git a/global.html b/global.html
index 8012d66f..35ff4026 100644
--- a/global.html
+++ b/global.html
@@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@ Properties:
+
+
+
+ pairId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sdrn
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ HasSessionFailureResponse
Source:
SimplifiedLoginData
Source:
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
accountUrl<
Source:
phonesUrlSource:
(as
Source:
error
Source:
login
Source:
logout
Source:
userChange
Source:
sessionChange
Source:
notLoggedin
Source:
sessionInit
Source:
statusChange
Source:
simplifiedLoginOpened
Source:
simplifiedLoginCancelledSource:
simplifiedLoginCancelled
diff --git a/Monetization.html b/Monetization.html
index 9e242800..b8f53381 100644
--- a/Monetization.html
+++ b/Monetization.html
@@ -23,7 +23,7 @@
@@ -1211,7 +1211,7 @@ Returns:
diff --git a/Payment.html b/Payment.html
index 9bf8615d..9e5e1e0e 100644
--- a/Payment.html
+++ b/Payment.html
@@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@ Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html
index abb7522b..feed752c 100644
--- a/RESTClient.js.html
+++ b/RESTClient.js.html
@@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@ RESTClient.js
diff --git a/config.js.html b/config.js.html
index 80e3f393..2cc41479 100644
--- a/config.js.html
+++ b/config.js.html
@@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@ config.js
diff --git a/global.html b/global.html
index 8012d66f..35ff4026 100644
--- a/global.html
+++ b/global.html
@@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@ Properties:
+
+
+
+ pairId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sdrn
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ HasSessionFailureResponse
Source:
SimplifiedLoginData
Source:
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
(as
Source:
error
Source:
login
Source:
logout
Source:
userChange
Source:
sessionChange
Source:
notLoggedin
Source:
sessionInit
Source:
statusChange
Source:
simplifiedLoginOpened
Source:
simplifiedLoginCancelledSource:
simplifiedLoginCancelled
diff --git a/Monetization.html b/Monetization.html
index 9e242800..b8f53381 100644
--- a/Monetization.html
+++ b/Monetization.html
@@ -23,7 +23,7 @@
@@ -1211,7 +1211,7 @@ Returns:
diff --git a/Payment.html b/Payment.html
index 9bf8615d..9e5e1e0e 100644
--- a/Payment.html
+++ b/Payment.html
@@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@ Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html
index abb7522b..feed752c 100644
--- a/RESTClient.js.html
+++ b/RESTClient.js.html
@@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@ RESTClient.js
diff --git a/config.js.html b/config.js.html
index 80e3f393..2cc41479 100644
--- a/config.js.html
+++ b/config.js.html
@@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@ config.js
diff --git a/global.html b/global.html
index 8012d66f..35ff4026 100644
--- a/global.html
+++ b/global.html
@@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@ Properties:
+
+
+
+ pairId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sdrn
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ HasSessionFailureResponse
Source:
SimplifiedLoginData
Source:
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
simplifiedLoginCancelled
diff --git a/Monetization.html b/Monetization.html
index 9e242800..b8f53381 100644
--- a/Monetization.html
+++ b/Monetization.html
@@ -23,7 +23,7 @@
@@ -1211,7 +1211,7 @@ Returns:
diff --git a/Payment.html b/Payment.html
index 9bf8615d..9e5e1e0e 100644
--- a/Payment.html
+++ b/Payment.html
@@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@ Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html
index abb7522b..feed752c 100644
--- a/RESTClient.js.html
+++ b/RESTClient.js.html
@@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@ RESTClient.js
diff --git a/config.js.html b/config.js.html
index 80e3f393..2cc41479 100644
--- a/config.js.html
+++ b/config.js.html
@@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@ config.js
diff --git a/global.html b/global.html
index 8012d66f..35ff4026 100644
--- a/global.html
+++ b/global.html
@@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@ Properties:
+
+
+
+ pairId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ sdrn
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ HasSessionFailureResponse
Source:
SimplifiedLoginData
Source:
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
Returns:
diff --git a/Payment.html b/Payment.html index 9bf8615d..9e5e1e0e 100644 --- a/Payment.html +++ b/Payment.html @@ -23,7 +23,7 @@
@@ -2136,7 +2136,7 @@
diff --git a/RESTClient.js.html b/RESTClient.js.html index abb7522b..feed752c 100644 --- a/RESTClient.js.html +++ b/RESTClient.js.html @@ -23,7 +23,7 @@
Returns:
diff --git a/RESTClient.js.html b/RESTClient.js.html index abb7522b..feed752c 100644 --- a/RESTClient.js.html +++ b/RESTClient.js.html @@ -23,7 +23,7 @@
@@ -239,7 +239,7 @@
diff --git a/config.js.html b/config.js.html index 80e3f393..2cc41479 100644 --- a/config.js.html +++ b/config.js.html @@ -23,7 +23,7 @@
RESTClient.js
diff --git a/config.js.html b/config.js.html index 80e3f393..2cc41479 100644 --- a/config.js.html +++ b/config.js.html @@ -23,7 +23,7 @@
@@ -143,7 +143,7 @@
diff --git a/global.html b/global.html index 8012d66f..35ff4026 100644 --- a/global.html +++ b/global.html @@ -23,7 +23,7 @@
config.js
diff --git a/global.html b/global.html index 8012d66f..35ff4026 100644 --- a/global.html +++ b/global.html @@ -23,7 +23,7 @@
@@ -1592,6 +1592,52 @@
+
+
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1630,7 +1676,7 @@ Source:
Source:
SimplifiedLoginWidgetOptions<
Properties:
+ +pairIdsdrnHasSessionFailureResponse
SimplifiedLoginData
SimplifiedLoginWidgetOptions<
Source:
Type:
diff --git a/identity.js.html b/identity.js.html
index 2ec734dd..bfb02103 100644
--- a/identity.js.html
+++ b/identity.js.html
@@ -23,7 +23,7 @@
@@ -150,6 +150,8 @@ identity.js
* @property {boolean} tracking - (Only for connected users)
* @property {boolean} clientAgreementAccepted - (Only for connected users)
* @property {boolean} defaultAgreementAccepted - (Only for connected users)
+ * @property {string} pairId
+ * @property {string} sdrn
*/
/**
@@ -632,8 +634,10 @@ identity.js
/**
* @async
- * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
- * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but
+ * @summary
+ * In Schibsted account, there are multiple ways of identifying a user; the `userId`,
+ * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}).
+ * There are reasons for them all to exist. The `userId` is a numeric identifier, but
* since Schibsted account is deployed separately in Norway and Sweden, there are a lot of
* duplicates. The `userId` was introduced early, so many sites still need to use them for
* legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of
@@ -651,6 +655,76 @@ identity.js
throw new SDKError('The user is not connected to this merchant');
}
+ /**
+ * @async
+ * @function
+ * @summary
+ * Retrieves the external identifier (`externalId`) for the authenticated user.
+ *
+ * In Schibsted Account there are multiple ways of identifying users, however for integrations with
+ * third-parties it's recommended to use `externalId` as it does not disclose
+ * any critical data whilst allowing for user identification.
+ *
+ * `externalId` is merchant-scoped using a pairwise identifier (`pairId`),
+ * meaning the same user's ID will differ between merchants.
+ * Additionally, this identifier is bound to the external party provided as argument.
+ *
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the `pairId` is missing in user session.
+ * @throws {SDKError} If the `externalParty` is not defined
+ * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId`
+ */
+ async getExternalId(externalParty, optionalSuffix = "") {
+ const { pairId } = await this.hasSession();
+
+ if (!pairId)
+ throw new SDKError('pairId missing in user session!');
+
+ if(!externalParty || externalParty.length === 0) {
+ throw new SDKError('externalParty cannot be empty');
+ }
+ const _toHexDigest = (hashBuffer) =>{
+ // convert buffer to byte array
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ // convert bytes to hex string
+ return hashArray.map(b => b.toString(16).padStart(2, '0')).join('');
+ }
+
+ const _getSha256Digest = (data) => {
+ return crypto.subtle.digest('SHA-256', data);
+ }
+
+ const _hashMessage = async (message) => {
+ const msgUint8 = new TextEncoder().encode(message);
+ return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it));
+ }
+
+ const _constructMessage = (pairId, externalParty, optionalSuffix) => {
+ return optionalSuffix
+ ? `${pairId}:${externalParty}:${optionalSuffix}`
+ : `${pairId}:${externalParty}`;
+ }
+
+ return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix))
+ }
+
+ /**
+ * @async
+ * @summary Enables brands to programmatically get the current the SDRN based on the user's session.
+ * @description This function calls {@link Identity#hasSession} internally and thus has the side
+ * effect that it might perform an auto-login on the user
+ * @throws {SDKError} If the SDRN is missing in user session object.
+ * @returns {Promise<string>}
+ */
+ async getUserSDRN() {
+ const { sdrn } = await this.hasSession();
+ if (sdrn) {
+ return sdrn;
+ }
+ throw new SDKError('Failed to get SDRN from user session');
+ }
+
/**
* @async
* @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the
@@ -991,7 +1065,7 @@ identity.js
diff --git a/index.html b/index.html
index 5cd29325..5e9f5e82 100644
--- a/index.html
+++ b/index.html
@@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@ LICENSE
diff --git a/monetization.js.html b/monetization.js.html
index a558a631..9a671dc5 100644
--- a/monetization.js.html
+++ b/monetization.js.html
@@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@ monetization.js
diff --git a/object.js.html b/object.js.html
index b31d4661..c4288591 100644
--- a/object.js.html
+++ b/object.js.html
@@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@ object.js
diff --git a/payment.js.html b/payment.js.html
index 650a68ee..e49607f0 100644
--- a/payment.js.html
+++ b/payment.js.html
@@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@ payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html
index 6a8a0828..af68a180 100644
--- a/spidTalk.js.html
+++ b/spidTalk.js.html
@@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@ spidTalk.js
diff --git a/url.js.html b/url.js.html
index 689c2fa5..39c66220 100644
--- a/url.js.html
+++ b/url.js.html
@@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@ url.js
diff --git a/validate.js.html b/validate.js.html
index 5bac92bd..413d86ab 100644
--- a/validate.js.html
+++ b/validate.js.html
@@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@ validate.js
identity.js
* @property {boolean} tracking - (Only for connected users) * @property {boolean} clientAgreementAccepted - (Only for connected users) * @property {boolean} defaultAgreementAccepted - (Only for connected users) + * @property {string} pairId + * @property {string} sdrn */ /** @@ -632,8 +634,10 @@identity.js
/** * @async - * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the - * `uuid`. There are reasons for them both existing. The `userId` is a numeric identifier, but + * @summary + * In Schibsted account, there are multiple ways of identifying a user; the `userId`, + * `uuid` and `externalId` used for identifying a user-merchant pair (see {@link Identity#getExternalId}). + * There are reasons for them all to exist. The `userId` is a numeric identifier, but * since Schibsted account is deployed separately in Norway and Sweden, there are a lot of * duplicates. The `userId` was introduced early, so many sites still need to use them for * legacy reasons. The `uuid` is universally unique, and so — if we could disregard a lot of @@ -651,6 +655,76 @@identity.js
throw new SDKError('The user is not connected to this merchant'); } + /** + * @async + * @function + * @summary + * Retrieves the external identifier (`externalId`) for the authenticated user. + * + * In Schibsted Account there are multiple ways of identifying users, however for integrations with + * third-parties it's recommended to use `externalId` as it does not disclose + * any critical data whilst allowing for user identification. + * + * `externalId` is merchant-scoped using a pairwise identifier (`pairId`), + * meaning the same user's ID will differ between merchants. + * Additionally, this identifier is bound to the external party provided as argument. + * + * @description This function calls {@link Identity#hasSession} internally and thus has the side + * effect that it might perform an auto-login on the user + * @throws {SDKError} If the `pairId` is missing in user session. + * @throws {SDKError} If the `externalParty` is not defined + * @return {Promise<string>} The merchant- and 3rd-party-specific `externalId` + */ + async getExternalId(externalParty, optionalSuffix = "") { + const { pairId } = await this.hasSession(); + + if (!pairId) + throw new SDKError('pairId missing in user session!'); + + if(!externalParty || externalParty.length === 0) { + throw new SDKError('externalParty cannot be empty'); + } + const _toHexDigest = (hashBuffer) =>{ + // convert buffer to byte array + const hashArray = Array.from(new Uint8Array(hashBuffer)); + // convert bytes to hex string + return hashArray.map(b => b.toString(16).padStart(2, '0')).join(''); + } + + const _getSha256Digest = (data) => { + return crypto.subtle.digest('SHA-256', data); + } + + const _hashMessage = async (message) => { + const msgUint8 = new TextEncoder().encode(message); + return _getSha256Digest(msgUint8).then( (it) => _toHexDigest(it)); + } + + const _constructMessage = (pairId, externalParty, optionalSuffix) => { + return optionalSuffix + ? `${pairId}:${externalParty}:${optionalSuffix}` + : `${pairId}:${externalParty}`; + } + + return _hashMessage(_constructMessage(pairId, externalParty, optionalSuffix)) + } + + /** + * @async + * @summary Enables brands to programmatically get the current the SDRN based on the user's session. + * @description This function calls {@link Identity#hasSession} internally and thus has the side + * effect that it might perform an auto-login on the user + * @throws {SDKError} If the SDRN is missing in user session object. + * @returns {Promise<string>} + */ + async getUserSDRN() { + const { sdrn } = await this.hasSession(); + if (sdrn) { + return sdrn; + } + throw new SDKError('Failed to get SDRN from user session'); + } + /** * @async * @summary In Schibsted account, there are two ways of identifying a user; the `userId` and the @@ -991,7 +1065,7 @@identity.js
diff --git a/index.html b/index.html index 5cd29325..5e9f5e82 100644 --- a/index.html +++ b/index.html @@ -23,7 +23,7 @@
@@ -342,7 +342,7 @@
diff --git a/monetization.js.html b/monetization.js.html index a558a631..9a671dc5 100644 --- a/monetization.js.html +++ b/monetization.js.html @@ -23,7 +23,7 @@
LICENSE
diff --git a/monetization.js.html b/monetization.js.html index a558a631..9a671dc5 100644 --- a/monetization.js.html +++ b/monetization.js.html @@ -23,7 +23,7 @@
@@ -208,7 +208,7 @@
diff --git a/object.js.html b/object.js.html index b31d4661..c4288591 100644 --- a/object.js.html +++ b/object.js.html @@ -23,7 +23,7 @@
monetization.js
diff --git a/object.js.html b/object.js.html index b31d4661..c4288591 100644 --- a/object.js.html +++ b/object.js.html @@ -23,7 +23,7 @@
@@ -109,7 +109,7 @@
diff --git a/payment.js.html b/payment.js.html index 650a68ee..e49607f0 100644 --- a/payment.js.html +++ b/payment.js.html @@ -23,7 +23,7 @@
object.js
diff --git a/payment.js.html b/payment.js.html index 650a68ee..e49607f0 100644 --- a/payment.js.html +++ b/payment.js.html @@ -23,7 +23,7 @@
@@ -259,7 +259,7 @@
diff --git a/spidTalk.js.html b/spidTalk.js.html index 6a8a0828..af68a180 100644 --- a/spidTalk.js.html +++ b/spidTalk.js.html @@ -23,7 +23,7 @@
payment.js
diff --git a/spidTalk.js.html b/spidTalk.js.html index 6a8a0828..af68a180 100644 --- a/spidTalk.js.html +++ b/spidTalk.js.html @@ -23,7 +23,7 @@
@@ -89,7 +89,7 @@
diff --git a/url.js.html b/url.js.html index 689c2fa5..39c66220 100644 --- a/url.js.html +++ b/url.js.html @@ -23,7 +23,7 @@
spidTalk.js
diff --git a/url.js.html b/url.js.html index 689c2fa5..39c66220 100644 --- a/url.js.html +++ b/url.js.html @@ -23,7 +23,7 @@
@@ -75,7 +75,7 @@
diff --git a/validate.js.html b/validate.js.html index 5bac92bd..413d86ab 100644 --- a/validate.js.html +++ b/validate.js.html @@ -23,7 +23,7 @@
url.js
diff --git a/validate.js.html b/validate.js.html index 5bac92bd..413d86ab 100644 --- a/validate.js.html +++ b/validate.js.html @@ -23,7 +23,7 @@
@@ -167,7 +167,7 @@