Skip to content

Commit e6443d2

Browse files
authored
Merge pull request #778 from IABTechLab/gwh-APIDOCS-2806-uid2-portal-differentiate-credentials
mods to differentiate credential types
2 parents 6626069 + 25a3a80 commit e6443d2

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

docs/getting-started/gs-credentials.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Notes:
4242
If you're using a client-server or server-side implementation (see [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md) or [Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)), the API key and client secret allow you to connect to the <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> and call API endpoints. These values identify you to the service.
4343

4444
Here is some information about API keys and client secrets:
45+
- You must keep these values secure. For details, see [Security of API Key and Client Secret]
4546
- One UID2 participant can have multiple keys.
4647
- Each key has a set of [permissions](gs-permissions.md) that determine the endpoints you can use it on.
4748
- Each key has a corresponding client secret.

docs/portal/api-keys.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ import Link from '@docusaurus/Link';
99

1010
# API Keys
1111

12+
:::note
13+
These instructions are for client-server or server-side implementations. If your UID2 implementation will be client-side, or visible to the public in any way, you'll need to set up different values. For details, see [Client-Side Integration](client-side-integrations.md).
14+
:::
15+
1216
In the UID2 Portal, on the **API Keys** page, you can perform all activities relating to managing the API keys for your UID2 account, including the following:
1317

1418
- [Adding an API Key](#adding-an-api-key)
@@ -20,7 +24,9 @@ In the UID2 Portal, on the **API Keys** page, you can perform all activities rel
2024

2125
The API key and client secret allow you to connect to the UID2 <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> and call API endpoints, directly or via one of the UID2 SDKs. These values identify you to the service.
2226

23-
When you add an API key in the UID2 Portal, it's very important that you store the key and its corresponding secret securely and do everything necessary to make sure that these values are not compromised. For more information, see [API Key and Client Secret](../getting-started/gs-credentials.md#api-key-and-client-secret).
27+
:::important
28+
When you add an API key in the UID2 Portal, you must store the key and its corresponding secret securely and do everything necessary to make sure that these values are not compromised. For more information, see [API Key and Client Secret](../getting-started/gs-credentials.md#api-key-and-client-secret).
29+
:::
2430

2531
We recommend rotating each API key on a yearly basis.
2632

docs/portal/client-side-integration.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ sidebar_position: 09
77

88
# Client-Side Integration
99

10+
:::note
11+
These instructions are for client-side implementations. If your UID2 implementation will be client-server or server-side, you'll need to set up different values. For details, see [API Keys](api-keys.md).
12+
:::
13+
1014
In the UID2 Portal, if you want to use an implementation option that generates UID2 tokens on the client side, you'll need to define the following values that are applicable to your implementation type:
1115

1216
| Value | Implementation Type | Details | Documentation Link |
@@ -40,6 +44,10 @@ Client-side implementation options are shown in the following table. The options
4044

4145
## Adding and Managing Key Pairs
4246

47+
:::note
48+
The key pair identifies you to the UID2 service, but the values are not secret. You do not need to store the key pair securely, and can share it, since it's intended for use in a client-side implementation.
49+
:::
50+
4351
On the Client-Side Integration page, you can perform the following activities relating to setting up and managing key pairs:
4452

4553
- [Adding a Key Pair](#adding-a-key-pair)

0 commit comments

Comments
 (0)