diff --git a/dev-docs/modules/userid-submodules/euid.md b/dev-docs/modules/userid-submodules/euid.md index 7f1321754e..4742a7e025 100644 --- a/dev-docs/modules/userid-submodules/euid.md +++ b/dev-docs/modules/userid-submodules/euid.md @@ -48,6 +48,23 @@ The following sample is fictitious, but shows what the token response object loo When this full data structure is provided, the module automatically refreshes the token periodically, as long as the refresh token hasn't expired. +The following example shows the response for a user that has opted out: + +```json +{ + identity: 'optout', + status: 'optout' +} +``` + +The following example shows the decoded EUID userId object: + +```json +euid: { + optout: true +} +``` + ## Client Refresh mode This is the recommended mode for most scenarios. In this mode, the full response body from the EUID Token Generate or Token Refresh endpoint must be provided to the module. As long as the refresh token remains valid, the module will refresh the advertising token as needed. diff --git a/dev-docs/modules/userid-submodules/unified2.md b/dev-docs/modules/userid-submodules/unified2.md index 74593d37df..651f0d708a 100644 --- a/dev-docs/modules/userid-submodules/unified2.md +++ b/dev-docs/modules/userid-submodules/unified2.md @@ -49,6 +49,23 @@ The following sample is fictitious, but shows what the token response object loo When this full data structure is provided, the module automatically refreshes the token periodically, as long as the refresh token hasn't expired. +The following example shows the response for a user that has opted out: + +```json +{ + identity: 'optout', + status: 'optout' +} +``` + +The following example shows the decoded UID2 userId object: + +```json +uid2: { + optout: true +} +``` + ## Unified ID 2.0 Server-Only Mode There is a server-only mode where the value of the advertising token can be provided either directly (see the `value` parameter in the [Unified ID 2.0 Configuration](#unified-id-20-configuration) section) or via a cookie. In this mode, no attempt is made to automatically refresh the token.