Skip to content

Commit

Permalink
Merge pull request #367 from IABTechLab/gwh-APIDOCS-1596-roles-permis…
Browse files Browse the repository at this point in the history
…sions-article

Gwh apidocs 1596 roles permissions article
  • Loading branch information
genwhittTTD authored Nov 22, 2023
2 parents 515b664 + 6389f81 commit aa7cb07
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 13 deletions.
2 changes: 0 additions & 2 deletions docs/getting-started/gs-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ Each UID2 <a href="/docs/intro#participants">participant</a> gets a set of uniqu
| Participants using a server-side endpoint | Both of the following:<ul><li>[API key](../ref-info/glossary-uid.md#gl-api-key), also called a client key</li><li>[Client secret](../ref-info/glossary-uid.md#gl-client-secret), a value known only to the participant and the UID2 service</li></ul> | Any integration using one of these endpoints: <ul><li>[POST /identity/map](../endpoints/post-identity-map.md)</li><li>[POST /identity/buckets](../endpoints/post-identity-buckets.md)</li><li>[POST /token/generate](../endpoints/post-token-generate.md)</li></ul> |
| Participants using a client-side implementation | Both of the following: <ul><li>Subscription ID</li><li>Public key</li></ul> | Integrations using one of these: <ul><li>[Prebid.js Express Integration Guide](../guides/integration-prebid.md)</li><li>[JavaScript Express Integration Guide](../guides/publisher-client-side.md)</li></ul> |



If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment.

<!-- It includes:
Expand Down
23 changes: 23 additions & 0 deletions docs/getting-started/gs-permissions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: API Permissions
description: Information about UID2 API permissions
hide_table_of_contents: false
sidebar_position: 07
---

# API Permissions

The UID2 ecosystem includes several different API permissions that allow access to complete specific activities. This approach is part of the overall secure design of UID2.

For each UID2 participant, the permissions are linked to the participant's API credentials (see [Account Setup](gs-account-setup.md) and [UID2 Credentials](gs-credentials.md)).

A participant can have one or several sets of API credentials with associated permissions. In cases where you have more than one API permission, you have the option to have a separate set of credentials for each permission or have a single set of credentials for all permissions. We recommend having a separate set of credentials for each permission.

The following table lists the key permissions, the types of participants that commonly use them, and a summary of the key associated activities.

| Name | Participant Type | Permissions |
| :--- | :--- | :--- |
| Generator | Publishers | Permission to call the [POST /token/generate](../endpoints/post-token-generate.md), [POST /token/validate](../endpoints/post-token-validate.md), and [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints, to generate UID2 tokens from DII and to refresh them, using one of these integration methods:<ul><li>A Prebid integration</li><li>The UID2 SDK for JavaScript</li><li>An integration that directly calls the applicable API endpoints for retrieving and managing UID2 tokens.</li></ul> |
| Bidder | DSPs | Permission to decrypt UID2 tokens coming in from the bid stream from publishers into raw UID2s for bidding purposes. |
| Sharer | Any participant type that takes part in UID2 sharing. For details, see [UID2 Sharing: Overview](../sharing/sharing-overview.md). | Permission to do both of the following:<ul><li>Encrypt raw UID2s into UID2 tokens for sharing with another authorized sharing participant, using a UID2 SDK or Snowflake</li><li>Decrypt UID2 tokens received from another authorized sharing participant into raw UID2s.</li></ul> |
| Mapper | Advertisers<br/>Data Providers | Permission to use the [POST /identity/buckets](../endpoints/post-identity-buckets.md) endpoint to monitor rotated salt buckets and to use the [POST /identity/map](../endpoints/post-identity-map.md) endpoint to map multiple email addresses, phone numbers, or their respective hashes to their raw UID2s and salt bucket IDs. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: API Permissions
description: Information about UID2 API permissions
hide_table_of_contents: false
sidebar_position: 07
---

# API Permissions

The UID2 ecosystem includes several different API permissions that allow access to complete specific activities. This approach is part of the overall secure design of UID2.

For each UID2 participant, the permissions are linked to the participant's API credentials (see [Account Setup](gs-account-setup.md) and [UID2 Credentials](gs-credentials.md)).

A participant can have one or several sets of API credentials with associated permissions. In cases where you have more than one API permission, you have the option to have a separate set of credentials for each permission or have a single set of credentials for all permissions. We recommend having a separate set of credentials for each permission.

The following table lists the key permissions, the types of participants that commonly use them, and a summary of the key associated activities.

| Name | Participant Type | Permissions |
| :--- | :--- | :--- |
| Generator | Publishers | Permission to call the [POST /token/generate](../endpoints/post-token-generate.md), [POST /token/validate](../endpoints/post-token-validate.md), and [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints, to generate UID2 tokens from DII and to refresh them, using one of these integration methods:<ul><li>A Prebid integration</li><li>The UID2 SDK for JavaScript</li><li>An integration that directly calls the applicable API endpoints for retrieving and managing UID2 tokens.</li></ul> |
| Bidder | DSPs | Permission to decrypt UID2 tokens coming in from the bid stream from publishers into raw UID2s for bidding purposes. |
| Sharer | Any participant type that takes part in UID2 sharing. For details, see [UID2 Sharing: Overview](../sharing/sharing-overview.md). | Permission to do both of the following:<ul><li>Encrypt raw UID2s into UID2 tokens for sharing with another authorized sharing participant, using a UID2 SDK or Snowflake</li><li>Decrypt UID2 tokens received from another authorized sharing participant into raw UID2s.</li></ul> |
| Mapper | Advertisers<br/>Data Providers | Permission to use the [POST /identity/buckets](../endpoints/post-identity-buckets.md) endpoint to monitor rotated salt buckets and to use the [POST /identity/map](../endpoints/post-identity-map.md) endpoint to map multiple email addresses, phone numbers, or their respective hashes to their raw UID2s and salt bucket IDs. |
12 changes: 1 addition & 11 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ const sidebars = {
items: [
'getting-started/gs-account-setup',
'getting-started/gs-credentials',
'getting-started/gs-permissions',
'getting-started/gs-auth',
'getting-started/gs-environments',
'getting-started/gs-api-using',
Expand Down Expand Up @@ -185,17 +186,6 @@ const sidebars = {
],
},












'summary-doc-v2',
{
type: 'category',
Expand Down

0 comments on commit aa7cb07

Please sign in to comment.