Skip to content

Commit 8bdcd20

Browse files
chore: add docs on restricting PAT creation (#1204)
## Overview <!-- Brief description of what documentation is being added/updated --> adds documentation on restricting PAT creation * restrict per-user: use the new `Organization Viewer` role * restrict for the entire organization: new `pat_creation_disabled` setting ## Type of change **Type:** Update existing documentation ## Related issues/PRs <!-- Link to related issues, feature PRs, or discussions (if applicable) To automatically close an issue when this PR is merged, use closing keywords: - "closes #123" or "fixes #123" or "resolves #123" For regular references without auto-closing, just use: - "#123" or "See issue #123" Examples: - closes #456 (will auto-close issue #456 when PR is merged) - See #789 for context (will reference but not auto-close issue #789) --> - GitHub issue: - Feature PR: <!-- For LangChain employees, if applicable: --> - Linear issue: ent-126 - Slack thread: ## Checklist <!-- Put an 'x' in all boxes that apply --> - [x] I have read the [contributing guidelines](README.md) - [x] I have tested my changes locally using `docs dev` - [x] All code examples have been tested and work correctly - [x] I have used **root relative** paths for internal links - [x] I have updated navigation in `src/docs.json` if needed - I have gotten approval from the relevant reviewers - (Internal team members only / optional) I have created a preview deployment using the [Create Preview Branch workflow](https://github.com/langchain-ai/docs/actions/workflows/create-preview-branch.yml) ## Additional notes <!-- Any other information that would be helpful for reviewers --> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent d4a78f4 commit 8bdcd20

File tree

2 files changed

+32
-18
lines changed

2 files changed

+32
-18
lines changed

β€Žsrc/langsmith/administration-overview.mdxβ€Ž

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -122,30 +122,35 @@ Organization roles are distinct from the Enterprise feature (RBAC) below and are
122122
The organization role selected also impacts workspace membership as described here:
123123

124124
* `Organization Admin` grants full access to manage all organization configuration, users, billing, and workspaces. **An `Organization Admin` has `Admin` access to all workspaces in an organization**
125-
* `Organization User` may read organization information but cannot execute any write actions at the organization level. **An `Organization User` can be added to a subset of workspaces and assigned workspace roles as usual (if RBAC is enabled), which specify permissions at the workspace level.**
125+
* `Organization User` may read organization information but cannot execute any write actions at the organization level. An `Organization User` may create Personal Access Tokens. **An `Organization User` can be added to a subset of workspaces and assigned workspace roles as usual (if RBAC is enabled), which specify permissions at the workspace level.**
126+
* `Organization Viewer` is equivalent to `Organization User`, but **cannot** create Personal Access Tokens. (for self-hosted, available in Helm chart version 0.11.25+)
126127

127128
<Info>
128-
The `Organization User` role is only available in organizations on plans with multiple workspaces. In organizations limited to a single workspace, all users are `Organization Admins`. Custom organization-scoped roles are not available yet.
129+
The `Organization User` and `Organization Viewer` roles are only available in organizations on plans with multiple workspaces. In organizations limited to a single workspace, all users are `Organization Admins`. Custom organization-scoped roles are not available yet.
130+
131+
See [security settings](/langsmith/manage-organization-by-api#security-settings) for instructions on how to disable PAT creation for the entire organization.
129132
</Info>
130133

131134
See the table below for all organization permissions:
132135

133-
| | Organization User | Organization Admin |
134-
| ------------------------------------------- | ----------------- | ------------------ |
135-
| View organization configuration | βœ… | βœ… |
136-
| View organization roles | βœ… | βœ… |
137-
| View organization members | βœ… | βœ… |
138-
| View data retention settings | βœ… | βœ… |
139-
| View usage limits | βœ… | βœ… |
140-
| Admin access to all workspaces | | βœ… |
141-
| Manage billing settings | | βœ… |
142-
| Create workspaces | | βœ… |
143-
| Create, edit, and delete organization roles | | βœ… |
144-
| Invite new users to organization | | βœ… |
145-
| Delete user invites | | βœ… |
146-
| Remove users from an organization | | βœ… |
147-
| Update data retention settings\* | | βœ… |
148-
| Update usage limits\* | | βœ… |
136+
| | Organization Viewer | Organization User | Organization Admin |
137+
| ------------------------------------------- | ------------------- | ----------------- | ------------------ |
138+
| View organization configuration | βœ… | βœ… | βœ… |
139+
| View organization roles | βœ… | βœ… | βœ… |
140+
| View organization members | βœ… | βœ… | βœ… |
141+
| View data retention settings | βœ… | βœ… | βœ… |
142+
| View usage limits | βœ… | βœ… | βœ… |
143+
| Create personal access tokens (PATs) | ❌ | βœ… | βœ… |
144+
| Admin access to all workspaces | ❌ | ❌ | βœ… |
145+
| Manage billing settings | ❌ | ❌ | βœ… |
146+
| Create workspaces | ❌ | ❌ | βœ… |
147+
| Create, edit, and delete organization roles | ❌ | ❌ | βœ… |
148+
| Invite new users to organization | ❌ | ❌ | βœ… |
149+
| Delete user invites | ❌ | ❌ | βœ… |
150+
| Remove users from an organization | ❌ | ❌ | βœ… |
151+
| Update data retention settings | ❌ | ❌ | βœ… |
152+
| Update usage limits | ❌ | ❌ | βœ… |
153+
149154

150155
### Workspace roles (RBAC)
151156

β€Žsrc/langsmith/manage-organization-by-api.mdxβ€Ž

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ These params should be omitted: `read_only` (deprecated), `password` and `full_n
7272

7373
## Security settings
7474

75+
<Note>
76+
Organization Admin permissions are required to make these changes.
77+
</Note>
78+
7579
<Note>
7680
"Shared resources" in this context refer to [public prompts](/langsmith/create-a-prompt#save-your-prompt), [shared runs](/langsmith/share-trace), and [shared datasets](/langsmith/manage-datasets#share-a-dataset).
7781
</Note>
@@ -84,6 +88,11 @@ You can update these settings under the **Settings > Shared** tab for a workspac
8488
* [Update organization sharing settings](https://api.smith.langchain.com/redoc#tag/orgs/operation/update_current_organization_info_api_v1_orgs_current_info_patch)
8589
* use `unshare_all` to unshare **ALL** shared resources in the organization - use `disable_public_sharing` to prevent future sharing of resources
8690

91+
These settings are only editable via API:
92+
* [Disable/enable PAT creation](https://api.smith.langchain.com/redoc#tag/orgs/operation/update_current_organization_info_api_v1_orgs_current_info_patch) (for self-hosted, available in Helm chart version 0.11.25+)
93+
* use `pat_creation_disabled` to disable PAT creation for the entire organization.
94+
* see the [admin guide](/langsmith/administration-overview#organization-roles) for information about the Organization Viewer role, which cannot create PATs.
95+
8796
## User-only endpoints
8897

8998
These endpoints are user-scoped and require a logged-in user's JWT, so they should only be executed through the UI.

0 commit comments

Comments
Β (0)