Skip to content

Commit 5f0bfb6

Browse files
committed
Feedback 2
1 parent 1667826 commit 5f0bfb6

File tree

4 files changed

+49
-29
lines changed

4 files changed

+49
-29
lines changed

src/langsmith/administration-overview.mdx

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ sidebarTitle: Overview
44
---
55

66
import OrgWorkspaceRole from '/snippets/langsmith/multi-workspace-org-roles.mdx';
7+
import PermissionReference from '/snippets/langsmith/permissions-reference.mdx';
78

89
This overview covers topics related to managing users, organizations, and workspaces within LangSmith.
910

@@ -119,21 +120,25 @@ To see how to create a service key or Personal Access Token, see the [setup guid
119120

120121
### Organization roles
121122

122-
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).
123124

124125
The organization role selected also impacts workspace membership as described here:
125126

126-
* `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**
127-
* `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.**
128-
* `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+).
129132

130133
<Info>
131134
<OrgWorkspaceRole/>
132135

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

136-
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:
137142

138143
| | Organization Viewer | Organization User | Organization Admin |
139144
| ------------------------------------------- | ------------------- | ----------------- | ------------------ |
@@ -153,6 +158,7 @@ See the table below for all organization permissions:
153158
| Update data retention settings ||||
154159
| Update usage limits ||||
155160

161+
<PermissionReference/>
156162

157163
### Workspace roles (RBAC)
158164

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

163169
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:
164170

165-
* `Admin` - has full access to all resources within the workspace
166-
* `Viewer` - has read-only access to all resources within the workspace
167-
* `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.
168174

169-
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.
170176

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

173-
![Roles](/langsmith/images/roles-tab-rbac.png)
179+
![](/langsmith/images/roles-tab-rbac.png)
174180

175-
For comprehensive documentation on roles and permissions, refer to the [Role-based access control](/langsmith/rbac) guide. For a detailed operations reference table, refer to the [Workspace Operations](/langsmith/organization-workspace-operations) page. For more details on assigning and creating roles, refer to the [User Management](/langsmith/user-management) guide.
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/>
176184

177185
## Best Practices
178186

src/langsmith/organization-workspace-operations.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -556,12 +556,12 @@ These operations are available to all authenticated users and don't require spec
556556

557557
### Organization to workspace
558558

559-
- **Organization Admin** automatically has full permissions in all workspaces.
560-
- **Organization User** and **Organization Viewer** only get workspace access when explicitly added to workspaces with workspace-level roles.
559+
- [Organization Admin](/langsmith/rbac#organization-admin) automatically has full permissions in all workspaces.
560+
- [Organization User](/langsmith/rbac#organization-user) and [Organization Viewer](/langsmith/rbac#organization-viewer) only get workspace access when explicitly added to workspaces with workspace-level roles.
561561

562562
For detailed role definitions, refer to [Organization roles](/langsmith/rbac#organization-roles) and [Workspace roles](/langsmith/rbac#workspace-roles).
563563

564564
### Workspace role independence
565565

566566
- Users can have different workspace roles in different workspaces.
567-
- A user might be a Workspace Admin in one workspace and a Workspace Viewer in another.
567+
- A user might be a [Workspace Admin](/langsmith/rbac#workspace-admin) in one workspace and a [Workspace Viewer](/langsmith/rbac#workspace-viewer) in another.

src/langsmith/rbac.mdx

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ sidebarTitle: Role-based access control
44
---
55

66
import OrgWorkspaceRole from '/snippets/langsmith/multi-workspace-org-roles.mdx';
7+
import PermissionReference from '/snippets/langsmith/permissions-reference.mdx';
78

89
This reference explains LangSmith's Role-Based Access Control (RBAC) system for managing organization-level and workspace-level permissions.
910

@@ -51,16 +52,18 @@ In organizations limited to a single workspace, all users are [Organization Admi
5152
- `organization:read` - Read access to all organization information
5253
- `organization:pats:create` - Create organization-level [personal access tokens](/langsmith/administration-overview#personal-access-tokens-pats)
5354

55+
<PermissionReference/>
56+
5457
**Key Capabilities**:
55-
- Manage organization settings and branding
58+
- Manage [organization settings](/langsmith/set-up-a-workspace#set-up-an-organization) and branding
5659
- Configure [SSO and authentication methods](/langsmith/user-management#set-up-saml-sso-for-your-organization)
57-
- Manage billing and subscription plans
58-
- Create and delete workspaces
60+
- Manage [billing](/langsmith/billing) and subscription plans
61+
- Create and delete [workspaces](/langsmith/set-up-a-workspace)
5962
- Invite and remove organization members
6063
- Assign organization and workspace roles to members
61-
- Create and manage custom roles
64+
- Create and manage [custom roles](#custom-roles)
6265
- Configure RBAC and ABAC (Attribute-Based Access Control) policies (Note that ABAC is in private preview)
63-
- View organization usage and analytics
66+
- View organization [usage](/langsmith/administration-overview#usage-limits) and analytics
6467

6568
For details on setting up and managing your organization, refer to the [Administration Overview](/langsmith/administration-overview#organizations).
6669

@@ -72,10 +75,12 @@ For details on setting up and managing your organization, refer to the [Administ
7275
- `organization:read` - Read access to organization information
7376
- `organization:pats:create` - Create personal access tokens
7477

78+
<PermissionReference/>
79+
7580
**Key Capabilities**:
7681
- View organization members and workspaces
7782
- View organization settings (but not modify)
78-
- Create personal access tokens for API access
83+
- Create [personal access tokens](/langsmith/administration-overview#personal-access-tokens-pats) for API access
7984
- Join workspaces they're invited to
8085

8186
**Restrictions**:
@@ -94,6 +99,8 @@ You can add an Organization User to a subset of workspaces and assigned workspac
9499
**Permissions**:
95100
- `organization:read` - Read access to organization information
96101

102+
<PermissionReference/>
103+
97104
**Key Capabilities**:
98105
- View organization members and workspaces
99106
- View organization settings
@@ -109,12 +116,12 @@ Workspace roles are part of the **Enterprise RBAC feature** and control what use
109116

110117
| Role | Description |
111118
|------|-------------|
112-
| Workspace Admin | Full permissions for all resources and ability to manage workspace |
113-
| Workspace Editor | Full permissions for most resources, cannot manage workspace settings or delete certain resources |
114-
| Workspace Viewer | Read-only access to all workspace resources |
119+
| [Workspace Admin](#workspace-admin) | Full permissions for all resources and ability to manage workspace |
120+
| [Workspace Editor](#workspace-editor) | Full permissions for most resources, cannot manage workspace settings or delete certain resources |
121+
| [Workspace Viewer](#workspace-viewer) | Read-only access to all workspace resources |
115122

116123
<Note>
117-
RBAC (Role-Based Access Control) is a feature that is only available to Enterprise customers. If you are interested in this feature, [contact our sales team](https://www.langchain.com/contact-sales). Other plans default to using the Admin role for all users.
124+
RBAC (Role-Based Access Control) is a feature that is only available to [Enterprise](https://langchain.com/pricing) customers. If you are interested in this feature, [contact our sales team](https://www.langchain.com/contact-sales). Other plans default to using the Admin role for all users.
118125
</Note>
119126

120127
#### Workspace Admin
@@ -125,12 +132,14 @@ RBAC (Role-Based Access Control) is a feature that is only available to Enterpri
125132
- All create, read, update, delete, and share permissions for all resource types
126133
- Workspace management capabilities
127134

135+
<PermissionReference/>
136+
128137
#### Workspace Editor
129138

130-
**Description**: Default role with full permissions for most resources. Cannot manage workspace settings or delete certain critical resources.
139+
**Description**: Role with full permissions for most resources. Cannot manage workspace settings or delete certain critical resources.
131140

132141
**Key Differences from Admin**:
133-
- Cannot delete runs
142+
- Cannot delete [runs](/langsmith/observability#runs)
134143
- Cannot manage workspace settings (add/remove members, change workspace name, etc.)
135144

136145
#### Workspace Viewer
@@ -139,6 +148,8 @@ RBAC (Role-Based Access Control) is a feature that is only available to Enterpri
139148

140149
**Permissions**: Read-only access to all resource types.
141150

151+
<PermissionReference/>
152+
142153
<Tip>
143154
For step-by-step instructions on assigning workspace roles to users, refer to the [User Management guide](/langsmith/user-management#assign-a-role-to-a-user).
144155
</Tip>
@@ -147,11 +158,11 @@ For step-by-step instructions on assigning workspace roles to users, refer to th
147158

148159
<Info>Creating custom roles is available for organizations on the Enterprise plan.</Info>
149160

150-
Organization Admins can create custom roles with specific combinations of permissions tailored to their organization's needs.
161+
[Organization Admins](#organization-admin) can create custom roles with specific combinations of permissions tailored to their organization's needs.
151162

152163
### Creating custom roles
153164

154-
Custom roles are created at the organization level and can be assigned to users in any workspace within that organization.
165+
Custom roles are created at the [organization](/langsmith/administration-overview#organizations) level and can be assigned to users in any [workspace](/langsmith/administration-overview#workspaces) within that organization.
155166

156167
**Steps**:
157168
1. Navigate to Organization **Settings** > **Roles**.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
For a comprehensive list of required permissions along with the operations and roles that can perform them, refer to the [Organization and workspace reference](/langsmith/organization-and-workspace-operations).

0 commit comments

Comments
 (0)