5a558eb09e
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / render-equality (push) Has been cancelled
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Has been cancelled
Python BE E2E Tests / Python BE E2E (push) Has been cancelled
Python Backend Tests / run-python-backend-tests (push) Has been cancelled
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
SDK E2E Libraries Integration Tests / Check Secrets (push) Has been cancelled
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Has been cancelled
SDK E2E Libraries Integration Tests / build-opik (push) Has been cancelled
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Has been cancelled
TypeScript SDK Build & Publish / build-and-publish (push) Has been cancelled
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Has been cancelled
Backend Tests / discover-tests (push) Has been cancelled
Backend Tests / ${{ matrix.name }} (push) Has been cancelled
Build and Publish SDK / build-and-publish (push) Has been cancelled
Build Opik Docker Images / set-version (push) Has been cancelled
Build Opik Docker Images / build-backend (push) Has been cancelled
Build Opik Docker Images / build-sandbox-executor-python (push) Has been cancelled
Build Opik Docker Images / build-python-backend (push) Has been cancelled
Build Opik Docker Images / build-frontend (push) Has been cancelled
Build Opik Docker Images / create-git-tag (push) Has been cancelled
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Has been cancelled
Docs - Publish / run (push) Has been cancelled
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Has been cancelled
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Has been cancelled
Frontend Unit Tests / Test on Node 20 (push) Has been cancelled
Guardrails E2E Tests / Select Python version matrix (push) Has been cancelled
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Guardrails E2E Tests / 📢 Slack Notification (push) Has been cancelled
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Has been cancelled
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Has been cancelled
Lint Opik Helm Chart / unittest-helm-chart (push) Has been cancelled
71 lines
3.2 KiB
Plaintext
71 lines
3.2 KiB
Plaintext
---
|
|
headline: Administration Overview | Opik Documentation
|
|
og:description: Learn how to manage users, workspaces, roles, and authentication settings in Opik for your organization.
|
|
og:site_name: Opik Documentation
|
|
og:title: 'Opik Administration: Managing Users, Workspaces, and Permissions'
|
|
subtitle: Multi-user collaboration with enterprise-grade access control
|
|
title: Overview
|
|
canonical-url: https://www.comet.com/docs/opik/administration/overview
|
|
---
|
|
|
|
Opik Cloud and Enterprise include administration features for teams and organizations, including:
|
|
|
|
- **Role-based access control**: Assign granular permissions at the organization and workspace level
|
|
- **Single sign-on (SSO)**: Authenticate users via SAML or OIDC with your identity provider
|
|
- **Workspace isolation**: Separate projects and data across teams with independent access controls
|
|
- **Service accounts**: Create API keys for CI/CD pipelines and automated workflows
|
|
- **User management**: Invite team members, assign roles, and manage access from a central dashboard
|
|
- **JWT authentication**: Integrate Opik into existing systems with token-based auth
|
|
|
|
<Note>
|
|
Available on [Opik Cloud](https://www.comet.com/site/products/opik/) and Enterprise. [Contact us](https://www.comet.com/site/about-us/contact-us/) for Enterprise pricing.
|
|
</Note>
|
|
|
|
## Get started
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Admin Dashboard" href="/v1/administration/admin-dashboard/overview">
|
|
Invite users, create workspaces, and manage organization settings from the admin UI.
|
|
</Card>
|
|
<Card title="Roles and Permissions" href="/v1/administration/roles_and_permissions">
|
|
Learn how organization roles and workspace roles control what users can access.
|
|
</Card>
|
|
<Card title="Authentication" href="/v1/administration/authentication/overview">
|
|
Set up SAML or OIDC single sign-on, or configure JWT for programmatic access.
|
|
</Card>
|
|
<Card title="Workspace Settings" href="/v1/administration/workspace-settings/overview">
|
|
Configure AI providers, feedback definitions, and other workspace-level preferences.
|
|
</Card>
|
|
</CardGroup>
|
|
|
|
## Key concepts
|
|
|
|
Opik uses a hierarchical structure to organize users and data:
|
|
|
|
| Term | Description |
|
|
| --- | --- |
|
|
| **Organization** | Your company or team. Contains all users, workspaces, and billing settings. |
|
|
| **Workspace** | A container for projects. Users can belong to multiple workspaces with different roles in each. |
|
|
| **Project** | A container for traces. Experiments and datasets live at the workspace level. |
|
|
| **Organization Role** | Controls organization-wide permissions (e.g., Admin can manage billing and users). |
|
|
| **Workspace Role** | Controls what a user can do within a specific workspace (e.g., Editor can create projects). |
|
|
|
|
Here's how these concepts relate:
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
Org[Organization] --> Users[Users + Org Roles]
|
|
Org --> Settings[Settings]
|
|
Org --> WS[Workspaces]
|
|
WS --> WSA[Workspace A]
|
|
WS --> WSB[Workspace B]
|
|
WSA --> MembersA[Members + Roles]
|
|
WSA --> ProjectsA[Projects]
|
|
WSB --> MembersB[Members + Roles]
|
|
WSB --> ProjectsB[Projects]
|
|
```
|
|
|
|
<Tip>
|
|
We recommend creating one workspace per team. This keeps projects organized and allows you to assign different roles to team members based on their responsibilities.
|
|
</Tip>
|