Skip to content

Commit

Permalink
Merge pull request #407 from IABTechLab/gwh-APIDOCS-1944-glossary-add…
Browse files Browse the repository at this point in the history
…-letters

add letters in glossary file
  • Loading branch information
genwhittTTD authored Jan 3, 2024
2 parents d3b175b + 6030c6e commit 3a14be0
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 6 deletions.
95 changes: 91 additions & 4 deletions docs/ref-info/glossary-uid.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ sidebar_position: 10
</tbody>
</table> -->

### A
<dl>

<dt class="jump-anchor" id="gl-advertising-id">Advertising ID</dt>
Expand All @@ -112,9 +113,21 @@ sidebar_position: 10
<dd>The Authorization header is a way to authenticate the client to the UID2 service.</dd>
<dd>For details, see <a href="https://www.rfc-editor.org/rfc/rfc9110.html#field.authorization">11.6.2. Authorization</a> in RFC 9110, the HTTP specification.</dd>

</dl>

### B

<dl>

<dt class="jump-anchor" id="gl-bearer-token">Bearer token</dt>
<dd>A bearer token is a special string that identifies the client. For authentication, some UID2 endpoints require the <a href="#gl-client-key">client key</a> to be specified as a bearer token in the Authorization header of the request: for example, <a href="../endpoints/post-token-generate">POST&nbsp;/token/generate</a>.</dd>

</dl>

### C

<dl>

<dt class="jump-anchor" id="gl-client-key">Client key</dt>
<dd>See <a href="#gl-api-key">API key</a>.</dd>

Expand All @@ -132,6 +145,12 @@ sidebar_position: 10
<dt class="jump-anchor" id="gl-customer-data-platform">Customer Data Platform (CDP)</dt>
<dd>A Customer Data Platform (CDP) is a prebuilt, packaged software system that creates a unified customer database that is accessible to other systems. The CDP centralizes customer data from multiple sources and makes the data available to other systems.</dd>

</dl>

### D

<dl>

<dt class="jump-anchor" id="gl-data-provider">Data provider</dt>
<dd>In the context of UID2, a data provider is any entity that provides data and measurement services relating to advertising, such as a data partner, measurement partner, or offline measurement provider.</dd>
<dd>For details, see <a href="/docs/intro#participants">participant</a> (Data Providers).</dd>
Expand All @@ -147,32 +166,71 @@ sidebar_position: 10
<dd>Docker is a Platform as a Service (PaaS) suite of products that is used for automating the deployment of software via packages called containers. The set of Docker products allows packaging of an application, with all its dependencies, into a virtual container that can run on most operating systems so that applications can work efficiently in different environments.</dd>
<dd>For details, see <a href="https://www.docker.com">https://www.docker.com</a>.</dd>

<!-- <dt class="jump-anchor" id="gl-docker-build">Docker Build</dt>
<dd>For details, see <a href="https://docs.docker.com/build/">Overview of Docker Build</a>.</dd> -->
</dl>

### E

<dl>

<dt class="jump-anchor" id="gl-enclave">Enclave</dt>
<dd>An enclave is a secure subsection of a computing environment. The enclave has additional business logic and security measures applied to it, to prevent anyone from tampering with it.</dd>
<dd>In the context of UID2, a <a href="#gl-private-operator">Private Operator</a> must run inside an enclave or in a private environment. For a summary of the enclave versions supported, see <a href="../guides/summary-guides#private-operator-service-integrations">Private Operator Service Integrations</a>.</dd>
<dd>In an enclave, the operator image must be a very specific, predefined version, and additional constraints are applied to ensure security.</dd>

</dl>

### F

<dl>

<dt class="jump-anchor" id="gl-first-level-hash">First-level hash</dt>
<dd>In the context of UID2, the first-level hash is the anonymized, opaque, secure value from which the <a href="#gl-raw-uid2">raw UID2</a>, <a href="#gl-uid2-token">UID2 token</a>, and <a href="#gl-refresh-token">refresh token</a> are generated. Several cryptographic functions, including salting and hashing, are applied to the initial value, whether an email or a phone number, to create the first-level hash.</dd>

</dl>

### H

<dl>

<dt class="jump-anchor" id="gl-hash">Hash</dt>
<dd>A hash function converts a set of data of varying/arbitrary size to a set of data of fixed size. The result of the hash function is called a hash, digest, or hash value.</dd>
<dd>Hashing is a one-way function. The same input value, hashed, always yields the same output value, but there is no corresponding function to take the output value and arrive at the input value. Hashing is a security measure.</dd>
<dd>UID2 uses the <a href="#gl-sha-256">SHA-256</a> hashing algorithm.</dd>

</dl>

### I

<dl>

<dt class="jump-anchor" id="gl-identity">Identity</dt>
<dd>In the context of UID2, the term "identity" refers to a package of values that includes the UID2 token, the refresh token, and associated values such as timestamps. This set of values is returned in the response from the <a href="../endpoints/post-token-generate">POST&nbsp;/token/generate</a> endpoint and also from the <a href="../endpoints/post-token-refresh">POST&nbsp;/token/refresh</a> endpoint.</dd>

</dl>

### J

<dl>

<dt class="jump-anchor" id="gl-json-web-token">JSON Web Token (JWT)</dt>
<dd>A JSON Web Token (JWT) is a compact, URL-safe means of representing claims (pieces of information) to be sent from one party to another over the web. The claims in a JWT are encoded as a JSON object that is used either as the payload of a JSON Web Signature (JWS) structure or as the plain text of a JSON Web Encryption (JWE) structure. This enables the claims to be digitally signed and/or encrypted.</dd>

</dl>

### N

<dl>

<dt class="jump-anchor" id="gl-normalize">Normalize</dt>
<dd>To normalize a data set means to bring it to a standard condition or state.</dd>
<dd>UID2 includes specific normalization rules. For details, see <a href="../getting-started/gs-normalization-encoding#email-address-normalization">Email Address Normalization</a> and <a href="../getting-started/gs-normalization-encoding#phone-number-normalization">Phone Number Normalization</a>.</dd>

</dl>

### O

<dl>

<dt class="jump-anchor" id="gl-open-operator">Open Operator</dt>
<dd>Open Operator is another term for a <a href="#gl-public-operator">Public Operator</a>.</dd>

Expand All @@ -198,6 +256,12 @@ sidebar_position: 10
<dd>The Opt-Out Service is a global UID2 service that manages and stores user opt-out requests.</dd>
<dd>For an overview of all the UID2 services, see <a href="../intro#components">Components</a>.</dd>

</dl>

### P

<dl>

<dt class="jump-anchor" id="gl-participant">Participant</dt>
<dd>An entity that fulfils a key role in UID2. Participants include the following: Core Administrator, Operator, DSP, data provider, advertiser, publisher, consumer.</dd>
<dd>For details, see <a href="../intro#participants">participants</a>.</dd>
Expand All @@ -216,6 +280,12 @@ sidebar_position: 10
<dd>A Public <a href="#gl-operator">Operator</a> is an entity that runs a public instance of the UID2 Operator Service. For example, The Trade Desk currently serves as a Public Operator for the UID2 framework, available to all participants.</dd>
<dd>For details, see <a href="../ref-info/ref-operators-public-private">The UID2 Operator</a>.</dd>

</dl>

### R

<dl>

<dt class="jump-anchor" id="gl-raw-uid2">Raw UID2</dt>
<dd>An unencrypted alphanumeric identifier created through the UID2 APIs or SDKs with the user's <a href="#gl-dii">directly identifying information</a> (email address or phone number) as input. The raw UID2 is encrypted to create a <a href="#gl-uid2-token">UID2 token</a>. The raw UID2 is a unique value; no two raw UID2s are the same. Raw UID2s, and their associated UID2 tokens, are case sensitive.</dd>
<dd>For details, see <a href="../intro#uid2-identifier-types">UID2 Identifier Types</a>.</dd>
Expand All @@ -224,6 +294,11 @@ sidebar_position: 10
<dd>A refresh token is an opaque string that is issued along with the <a href="#gl-uid2-token">UID2 token</a>. It is used to refresh the UID2 token, which has a limited life.</dd>
<dd>When the UID2 server receives the refresh token with a request for a new UID2 token, it checks for user opt-out. If the user has opted out of UID2, no new UID2 token is generated.</dd>
<dd>When a new UID2 token is generated and returned, a new refresh token is returned along with it. However, if the user is inactive for a long period of time, the refresh token itself expires.</dd>
</dl>

### S

<dl>

<dt class="jump-anchor" id="gl-salt">Salt</dt>
<dd>A string of characters that is used in the process of transforming an email address or phone number into a secure, opaque value that cannot be traced back to the original value.</dd>
Expand All @@ -245,11 +320,11 @@ sidebar_position: 10
<dd>SHA-256 is part of the SHA-2 family of algorithms developed by the National Institute of Standards and Technology (NIST) and the National Security Agency (NSA) to succeed SHA-1. Each algorithm is named according to the number of bits in the output, so SHA-256 has 256 bits.</dd>
<dd>For details, see <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf">https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf</a> (specification).</dd>

<dt class="jump-anchor" id="gl-sharing">sharing</dt>
<dt class="jump-anchor" id="gl-sharing">Sharing</dt>
<dd>In the context of UID2, sharing is a process for distributing <a href="#gl-raw-uid2">raw UID2s</a> securely between UID2 participants. To protect raw UID2s from unauthorized access, the originating participant (sender) must encrypt the raw UID2s into UID2 tokens before transmission. The destination participant (receiver) must decrypt the UID2 tokens into raw UID2s for internal use.</dd>
<dd>For details, see <a href="../sharing/sharing-overview">UID2 Sharing: Overview</a>.</dd>

<dt class="jump-anchor" id="gl-sharing-participant">sharing participant</dt>
<dt class="jump-anchor" id="gl-sharing-participant">Sharing participant</dt>
<dd>In UID2, a sharing participant is a company that takes part in <a href="#gl-sharing">sharing</a>&#8212;distributing <a href="#gl-raw-uid2">raw UID2s</a> securely between UID2 participants. A sharing participant can be a publisher, advertiser, DSP, or data provider, or might have more than one of these roles.</dd>
<dd>For details, see <a href="../sharing/sharing-overview">UID2 Sharing: Overview</a>.</dd>

Expand All @@ -259,9 +334,21 @@ sidebar_position: 10
<dt class="jump-anchor" id="gl-subscription-id">Subscription ID</dt>
<dd>For server-side publisher integrations, the subscription ID is one of the two values issued to publishers as their UID2 credentials. For details, see <a href="../getting-started/gs-credentials#subscription-id-and-public-key">Subscription ID and Public Key</a>.</dd>

</dl>

### T

<dl>

<dt class="jump-anchor" id="gl-transparency-and-control-portal">Transparency and Control Portal</dt>
<dd>The UID2 Transparency and Control Portal is a user-facing website, <a href="https://www.transparentadvertising.com/">https://www.transparentadvertising.com/</a>, that allows consumers to opt out of UID2 at any time.</dd>

</dl>

### U

<dl>

<dt class="jump-anchor" id="gl-uid2-framework">UID2 framework</dt>
<dd>The Unified ID 2.0 (UID2) framework enables deterministic identity for advertising opportunities on the open internet for many <a href="../intro#participants">participants</a> across the advertising ecosystem. It enables logged-in experiences from publisher websites, mobile apps, and Connected TV (CTV) apps to monetize through programmatic workflows. Built as an open-source, standalone solution with its own unique namespace, the framework focuses on transparency and privacy.</dd>

Expand Down
2 changes: 0 additions & 2 deletions docs/ref-info/updates-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ Check out the latest updates to our UID2 documentation resources.

3 January 2024

Happy New Year!

We've added a reference article explaining what the UID2 Operator does and the differences between a Public Operator and a Private Operator.

For details, see [The UID2 Operator](../ref-info/ref-operators-public-private.md).
Expand Down

0 comments on commit 3a14be0

Please sign in to comment.