mirror of
https://github.com/fosrl/docs-v2.git
synced 2026-04-16 06:46:42 +00:00
docs: refine links page and navigation
This commit is contained in:
@@ -69,6 +69,7 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
"manage/access-control/links",
|
||||||
{
|
{
|
||||||
"group": "Clients",
|
"group": "Clients",
|
||||||
"icon": "desktop",
|
"icon": "desktop",
|
||||||
@@ -97,7 +98,6 @@
|
|||||||
"manage/access-control/create-user",
|
"manage/access-control/create-user",
|
||||||
"manage/access-control/approvals",
|
"manage/access-control/approvals",
|
||||||
"manage/access-control/rules",
|
"manage/access-control/rules",
|
||||||
"manage/access-control/links",
|
|
||||||
"manage/access-control/forwarded-headers",
|
"manage/access-control/forwarded-headers",
|
||||||
"manage/access-control/login-page",
|
"manage/access-control/login-page",
|
||||||
"manage/ssh",
|
"manage/ssh",
|
||||||
|
|||||||
BIN
images/links-access-token-usage.png
Normal file
BIN
images/links-access-token-usage.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 297 KiB |
BIN
images/links-create-modal.png
Normal file
BIN
images/links-create-modal.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 225 KiB |
BIN
images/links-dashboard.png
Normal file
BIN
images/links-dashboard.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 187 KiB |
@@ -1,46 +1,52 @@
|
|||||||
---
|
---
|
||||||
title: "Share Links"
|
title: "Links"
|
||||||
icon: "link"
|
icon: "link"
|
||||||
description: "Create share links and use access tokens for browser or programmatic access."
|
description: "Create Links and use access tokens for browser or programmatic access."
|
||||||
---
|
---
|
||||||
|
|
||||||
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
import PangolinCloudTocCta from "/snippets/pangolin-cloud-toc-cta.mdx";
|
||||||
|
|
||||||
<PangolinCloudTocCta />
|
<PangolinCloudTocCta />
|
||||||
|
|
||||||
A share link is a special URL that grants access to one resource without requiring the recipient to sign in as a Pangolin user.
|
<img src="/images/links-dashboard.png" alt="Links in the Pangolin dashboard" />
|
||||||
|
|
||||||
When you create one, Pangolin gives you two ways to use it:
|
Links are special URLs that grant access to one resource without requiring the recipient to sign in as a Pangolin user.
|
||||||
|
|
||||||
- **Share Link**: Send this to a person. This is a Pangolin-hosted share URL, usually on your Pangolin domain, that validates the link and then redirects them to the resource.
|
When you create a Link, Pangolin gives you two ways to use it:
|
||||||
|
|
||||||
|
- **Link**: Send this to a person. This is a Pangolin-hosted URL, usually on your Pangolin domain, that validates the Link and then redirects them to the resource.
|
||||||
- **Access Token Usage**: Use this only when making direct requests to the resource URL from scripts, tools, or integrations.
|
- **Access Token Usage**: Use this only when making direct requests to the resource URL from scripts, tools, or integrations.
|
||||||
|
|
||||||
## Create a Share Link
|
## Create a Link
|
||||||
|
|
||||||
From the resource authentication flow, create a share link by:
|
From the resource authentication flow, create a Link by:
|
||||||
|
|
||||||
1. Choosing the target resource.
|
1. Choosing the target resource.
|
||||||
2. Adding a title if you want the link to be easy to identify later.
|
2. Adding a title if you want the link to be easy to identify later.
|
||||||
3. Setting an expiration, or enabling **Never expire** if the link should stay valid until you revoke it.
|
3. Setting an expiration, or enabling **Never expire** if the link should stay valid until you revoke it.
|
||||||
4. Copying the generated link or access-token details immediately after creation.
|
4. Copying the generated link or access-token details immediately after creation.
|
||||||
|
|
||||||
|
<img src="/images/links-create-modal.png" alt="Create a Link modal" />
|
||||||
|
|
||||||
<Warning>
|
<Warning>
|
||||||
Anyone with the link or access token can use it. Treat both like credentials.
|
Anyone with the Link or access token can use it. Treat both like credentials.
|
||||||
</Warning>
|
</Warning>
|
||||||
|
|
||||||
## Use the Access Token
|
## Use the Access Token
|
||||||
|
|
||||||
Pangolin can accept a share-link access token in either the query string or request headers.
|
Pangolin can accept a Link access token in either the query string or request headers.
|
||||||
|
|
||||||
If you are sending access to a person, use the copied **Share Link**.
|
If you are sending access to a person, use the copied **Link** shown at the top of the modal.
|
||||||
|
|
||||||
Use **Access Token Usage** only when you are calling the resource URL directly on each request.
|
Use **Access Token Usage** only when you are calling the resource URL directly on each request.
|
||||||
|
|
||||||
This is why the two URLs often look different:
|
This is why the two URLs often look different:
|
||||||
|
|
||||||
- The **Share Link** is usually on your Pangolin domain.
|
- The **Link** is usually on your Pangolin domain.
|
||||||
- The **Access Token Usage** examples use the resource URL directly.
|
- The **Access Token Usage** examples use the resource URL directly.
|
||||||
|
|
||||||
|
<img src="/images/links-access-token-usage.png" alt="Access Token Usage examples" />
|
||||||
|
|
||||||
### Query Parameter
|
### Query Parameter
|
||||||
|
|
||||||
By default, Pangolin accepts the access token in the `p_token` query parameter:
|
By default, Pangolin accepts the access token in the `p_token` query parameter:
|
||||||
@@ -77,10 +83,10 @@ Some deployments may use different header names.
|
|||||||
|
|
||||||
- Expiring links stop working automatically when their lifetime ends.
|
- Expiring links stop working automatically when their lifetime ends.
|
||||||
- Non-expiring links remain valid until you delete them.
|
- Non-expiring links remain valid until you delete them.
|
||||||
- Deleting the share link revokes both the link and its access token.
|
- Deleting the Link revokes both the Link and its access token.
|
||||||
|
|
||||||
## Important Notes
|
## Important Notes
|
||||||
|
|
||||||
- Share links are best for targeted sharing and automation, not broad long-term access.
|
- Links are best for targeted sharing and automation, not broad long-term access.
|
||||||
- Share-link access does not carry per-user identity headers to the upstream app. For identity-aware upstream integrations, see [Forwarded Headers](/manage/access-control/forwarded-headers).
|
- Link-based access does not carry per-user identity headers to the upstream app. For identity-aware upstream integrations, see [Forwarded Headers](/manage/access-control/forwarded-headers).
|
||||||
- For the underlying auth settings on the resource itself, see [Authentication](/manage/resources/public/authentication).
|
- For the underlying auth settings on the resource itself, see [Authentication](/manage/resources/public/authentication).
|
||||||
|
|||||||
Reference in New Issue
Block a user