Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/getting-started/gs-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Notes:
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.

Here is some information about API keys and client secrets:
- You must keep these values secure. For details, see [Security of API Key and Client Secret]
- One UID2 participant can have multiple keys.
- Each key has a set of [permissions](gs-permissions.md) that determine the endpoints you can use it on.
- Each key has a corresponding client secret.
Expand Down
8 changes: 7 additions & 1 deletion docs/portal/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ import Link from '@docusaurus/Link';

# API Keys

:::note
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).
:::

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:

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

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.

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).
:::important
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).
:::

We recommend rotating each API key on a yearly basis.

Expand Down
8 changes: 8 additions & 0 deletions docs/portal/client-side-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ sidebar_position: 09

# Client-Side Integration

:::note
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).
:::

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:

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

## Adding and Managing Key Pairs

:::note
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.
:::

On the Client-Side Integration page, you can perform the following activities relating to setting up and managing key pairs:

- [Adding a Key Pair](#adding-a-key-pair)
Expand Down
Loading