Skip to content

Commit 549915a

Browse files
authored
1 parent 631579c commit 549915a

File tree

7 files changed

+783
-14
lines changed

7 files changed

+783
-14
lines changed

β€Žsrc/docs.jsonβ€Ž

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -867,8 +867,15 @@
867867
"langsmith/data-purging-compliance"
868868
]
869869
},
870+
{
871+
"group": "Access control & Authentication",
872+
"pages": [
873+
"langsmith/rbac",
874+
"langsmith/organization-workspace-operations",
875+
"langsmith/authentication-methods"
876+
]
877+
},
870878
"langsmith/scalability-and-resilience",
871-
"langsmith/authentication-methods",
872879
"langsmith/faq",
873880
"langsmith/regions-faq",
874881
"langsmith/pricing-faq"

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

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: Overview
33
sidebarTitle: Overview
44
---
55

6+
import OrgWorkspaceRole from '/snippets/langsmith/multi-workspace-org-roles.mdx';
7+
import PermissionReference from '/snippets/langsmith/permissions-reference.mdx';
8+
69
This overview covers topics related to managing users, organizations, and workspaces within LangSmith.
710

811
## Resource Hierarchy
@@ -117,21 +120,25 @@ To see how to create a service key or Personal Access Token, see the [setup guid
117120

118121
### Organization roles
119122

120-
Organization roles are distinct from the Enterprise feature (RBAC) below and are used in the context of multiple [workspaces](#workspaces). Your organization role determines your workspace membership characteristics and your organization-level permissions. See the [organization setup guide](/langsmith/set-up-a-workspace#organization-roles) for more information.
123+
Organization roles are distinct from the [Enterprise feature workspace RBAC](#workspace-roles-rbac) and are used in the context of multiple [workspaces](#workspaces). Your organization role determines your workspace membership characteristics and your [organization-level permissions](/langsmith/organization-workspace-operations).
121124

122125
The organization role selected also impacts workspace membership as described here:
123126

124-
* `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` 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+)
127+
- [Organization Admin](/langsmith/rbac#organization-admin) grants full access to manage all organization configuration, users, billing, and workspaces.
128+
- An Organization Admin has `Admin` access to all workspaces in an organization.
129+
- [Organization User](/langsmith/rbac#organization-user) may read organization information but cannot execute any write actions at the organization level. An Organization User may create [Personal Access Tokens](#personal-access-tokens-pats).
130+
- 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.
131+
- [Organization Viewer](/langsmith/rbac#organization-viewer) is equivalent to Organization User, but **cannot** create Personal Access Tokens. (for self-hosted, available in Helm chart version 0.11.25+).
127132

128133
<Info>
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.
134+
<OrgWorkspaceRole/>
130135

131136
See [security settings](/langsmith/manage-organization-by-api#security-settings) for instructions on how to disable PAT creation for the entire organization.
132137
</Info>
133138

134-
See the table below for all organization permissions:
139+
For more information on setting up organizations and workspaces, refer to the [organization setup guide](/langsmith/set-up-a-workspace#organization-roles) for more information.
140+
141+
The following table provdies an overview of organization level permissions:
135142

136143
| | Organization Viewer | Organization User | Organization Admin |
137144
| ------------------------------------------- | ------------------- | ----------------- | ------------------ |
@@ -151,6 +158,7 @@ See the table below for all organization permissions:
151158
| Update data retention settings | ❌ | ❌ | βœ… |
152159
| Update usage limits | ❌ | ❌ | βœ… |
153160

161+
<PermissionReference/>
154162

155163
### Workspace roles (RBAC)
156164

@@ -160,17 +168,19 @@ RBAC (Role-Based Access Control) is a feature that is only available to Enterpri
160168

161169
Roles are used to define the set of permissions that a user has within a workspace. There are three built-in system roles that cannot be edited:
162170

163-
* `Admin` - has full access to all resources within the workspace
164-
* `Viewer` - has read-only access to all resources within the workspace
165-
* `Editor` - has full permissions except for workspace management (adding/removing users, changing roles, configuring service keys)
171+
- [Workspace Admin](/langsmith/rbac#workspace-admin) has full access to all resources within the workspace.
172+
- [Workspace Editor](/langsmith/rbac#workspace-editor) has full permissions except for workspace management (adding/removing users, changing roles, configuring service keys).
173+
- [Workspace Viewer](/langsmith/rbac#workspace-viewer) has read-only access to all resources within the workspace.
166174

167-
Organization admins can also create/edit custom roles with specific permissions for different resources.
175+
[Organization admins](/langsmith/rbac#organization-admin) can also create/edit custom roles with specific permissions for different resources.
168176

169-
Roles can be managed in organization settings under the `Roles` tab:
177+
Roles can be managed in **Organization Settings** under the **Roles** tab:
170178

171-
![Roles](/langsmith/images/roles-tab-rbac.png)
179+
![The Organization members and roles view showing a list of the roles.](/langsmith/images/roles-tab-rbac.png)
172180

173-
For more details on assigning and creating roles, see the [access control setup guide](/langsmith/user-management).
181+
- For comprehensive documentation on roles and permissions, refer to the [Role-based access control](/langsmith/rbac) guide.
182+
- For more details on assigning and creating roles, refer to the [User Management](/langsmith/user-management) guide.
183+
- <PermissionReference/>
174184

175185
## Best Practices
176186

0 commit comments

Comments
Β (0)