diff --git a/docs/getting-started/gs-credentials.md b/docs/getting-started/gs-credentials.md index 96ff6fdf4..7598ec7bd 100644 --- a/docs/getting-started/gs-credentials.md +++ b/docs/getting-started/gs-credentials.md @@ -13,11 +13,34 @@ Each UID2 participant gets a set of uniqu | Audience | Credentials | Integration | | :--- | :--- | :--- | -| Participants using a server-side endpoint | Both of the following: | Any integration using one of these endpoints: | | Participants using a client-side implementation | Both of the following: These two, together, are sometimes called client keypair. | Integrations using one of these: | +| Participants using a client-server implementation | Both of the following: | Integrations using one of these: | +| Participants using a server-side endpoint | Both of the following: | Integrations using one of these: | If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment. +## Subscription ID and Public Key + +If you're using a client-side implementation (see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) or [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)), you'll receive the following credentials: +- **Subscription ID**: This value identifies your site to the UID2 service. +- **Public key**: This value is used for encryption. + +**Client keypair** is a group term we use for these two values, which are used to uniquely define an account that's using an implementation that generates the token on the client side. + +When you're implementing UID2 on the client side, by using the UID2 JavaScript SDK, Client-Side Integration for Mobile, or Prebid.js, provide the values to the SDK or to Prebid.js as part of configuration. + +Notes: + +- Unlike the API key and client secret, the Subscription ID and public key do not have to be kept secure. + +- The values are valid for a specific [environment](gs-environments.md). If you're using both the integration and production environments, you'll get a set of credentials for each environment. + +- Subscription ID and public key credentials can be used only to generate client-side tokens. If you need any additional roles (see [API Permissions](gs-permissions.md)), request API Key and Client Secret for those roles. + +## Refreshing Credentials + +To request new credentials at any time, ask your UID2 contact. + ## API Key and Client Secret If you're using a client-server or server-side implementation (see [UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-server-side.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 Operator Service and call API endpoints. These values identify you to the service. @@ -41,25 +64,3 @@ Security of keys and client secrets is very important. Follow these guidelines: - Establish a process for replacing the key and secret with new values if the existing ones are compromised. It's best to refresh your API key and client secret on a regular cadence—for example, yearly—to help reduce the risk of your credentials being compromised. - -## Subscription ID and Public Key - -If you're using a client-side implementation (see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md) or [Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)), you'll receive the following credentials: -- **Subscription ID**: This value identifies your site to the UID2 service. -- **Public key**: This value is used for encryption. - -**Client keypair** is a group term we use for these two values, which are used to uniquely define an account that's using an implementation that generates the token on the client side. - -When you're implementing UID2 on the client side, by using the UID2 JavaScript SDK, Client-Side Integration for Mobile, or Prebid.js, provide the values to the SDK or to Prebid.js as part of configuration. - -Notes: - -- Unlike the API key and client secret, the Subscription ID and public key do not have to be kept secure. - -- The values are valid for a specific [environment](gs-environments.md). If you're using both the integration and production environments, you'll get a set of credentials for each environment. - -- Subscription ID and public key credentials can be used only to generate client-side tokens. If you need any additional roles (see [API Permissions](gs-permissions.md)), request API Key and Client Secret for those roles. - -## Refreshing Credentials - -To request new credentials at any time, ask your UID2 contact.