Add scope pinning and other improvements to privilege worker docs#1539
Open
seand52 wants to merge 4 commits into
Open
Add scope pinning and other improvements to privilege worker docs#1539seand52 wants to merge 4 commits into
seand52 wants to merge 4 commits into
Conversation
Contributor
Summary
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
hazel-nut
reviewed
Jul 15, 2026
hazel-nut
left a comment
hazel-nut
left a comment
Contributor
There was a problem hiding this comment.
a few copyediting notes
Comment on lines
6
to
8
| <Callout icon="file-lines" color="#0EA5E9" iconType="regular"> | ||
| Privileged Worker Token Exchange with Token Vault is currently in Beta. To learn more about Auth0’s product release cycle, read [Product Release Stages](/docs/troubleshoot/product-lifecycle/product-release-stages). To participate in this program, contact [Auth0 Support](https://support.auth0.com/) or your Technical Account Manager. | ||
| Privileged Worker Token Exchange with Token Vault is currently in Early Access. To learn more about Auth0’s product release cycle, read [Product Release Stages](/docs/troubleshoot/product-lifecycle/product-release-stages). To participate in this program, contact [Auth0 Support](https://support.auth0.com/) or your Technical Account Manager. | ||
| </Callout> |
| ## Configure client application | ||
|
|
||
| To configure the client application's privileged access to Token Vault, you need to provide a public key that will be used to verify a signed JWT as the subject token. | ||
| To configure the client application's privileged access to Token Vault, you need to provide a public key that will be used to verify a signed JWT as the subject token. You also need to restrict which IP addresses the client may make requests from, and pin the client to the connections and scopes it's allowed to request — without these, the Privileged Worker Token Exchange will not work. |
Contributor
There was a problem hiding this comment.
Suggested change
| To configure the client application's privileged access to Token Vault, you need to provide a public key that will be used to verify a signed JWT as the subject token. You also need to restrict which IP addresses the client may make requests from, and pin the client to the connections and scopes it's allowed to request — without these, the Privileged Worker Token Exchange will not work. | |
| To configure the client application's privileged access to Token Vault, you must: | |
| * Provide a public key, which is used to verify a signed JWT as the subject token. | |
| * Restrict which IP addresses the client may make requests from. | |
| * Pin the client to the connections and scopes it's allowed to request. |
| 2. Select the **Settings** tab, scroll to the **Privileged Worker** section, and toggle on **Enable Privileged Worker**. In the modal, select an existing public key credential or upload a new one, then select **Save**. | ||
| 3. Once the credential is saved, enter at least one IP address or CIDR range in the **IP Allowlist** field. | ||
| 4. Select **Save Changes**. | ||
| 4. Under **Permissions**, select **Add Permission**. In the modal, select a **Connection** and enter the **Scopes** this connection is allowed to request, then select **Save**. Repeat for each connection you want to allow. You can configure up to 5 permissions and 20 scopes in total. |
Contributor
There was a problem hiding this comment.
Suggested change
| 4. Under **Permissions**, select **Add Permission**. In the modal, select a **Connection** and enter the **Scopes** this connection is allowed to request, then select **Save**. Repeat for each connection you want to allow. You can configure up to 5 permissions and 20 scopes in total. | |
| 4. Under **Permissions**, select **Add Permission**. In the window, select a **Connection** and enter the **Scopes** this connection is allowed to request, then select **Save**. Repeat for each connection you want to allow. You can configure up to 5 permissions and 20 scopes in total. |
| 4. Select **Save Changes**. | ||
| 4. Under **Permissions**, select **Add Permission**. In the modal, select a **Connection** and enter the **Scopes** this connection is allowed to request, then select **Save**. Repeat for each connection you want to allow. You can configure up to 5 permissions and 20 scopes in total. | ||
| 5. Select **Save Changes**. | ||
| 6. For each connection referenced in **Permissions**, make sure it's also enabled for this application. Navigate to **Authentication > [Connection type]**, select the connection, go to the **Applications** tab, and toggle the connection on for your application. |
Contributor
There was a problem hiding this comment.
Suggested change
| 6. For each connection referenced in **Permissions**, make sure it's also enabled for this application. Navigate to **Authentication > [Connection type]**, select the connection, go to the **Applications** tab, and toggle the connection on for your application. | |
| 6. Enable each connection referenced in **Permissions** for this application. Navigate to **Authentication > [Connection type]**, select the connection, go to the **Applications** tab, and toggle the connection on for your application. |
| ### Configure IP allowlist | ||
|
|
||
| To restrict which IP addresses may make Privileged Worker exchange requests, configure an `ip_allowlist` on your client. This binds the client credential to known server egress IPs, so a leaked credential cannot be used from an arbitrary IP address. Both IPv4 and IPv6 addresses and CIDR ranges are supported, with a maximum of 10 entries. | ||
| For each connection referenced in `grants`, the connection must also be enabled for this client. Enable it with: |
Contributor
There was a problem hiding this comment.
Suggested change
| For each connection referenced in `grants`, the connection must also be enabled for this client. Enable it with: | |
| For each connection referenced in `grants`, you must also enable the connection for this client: |
| @@ -1,19 +1,19 @@ | |||
| --- | |||
| description: Learn how an application can access the Token Vault to exchange a JWT bearer token for an access or refresh token to call external APIs. | |||
| description: Learn how an application can access the Token Vault to exchange a JWT bearer token for an access token to call external APIs. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| description: Learn how an application can access the Token Vault to exchange a JWT bearer token for an access token to call external APIs. | |
| description: Grant an application access to Token Vault so it can exchange a JWT bearer token for an access token to call external APIs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Update privilege worker documentation with the following:
References
Testing
Checklist
CONTRIBUTING.md.