> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.omni.co/feedback
```json
{
"path": "/api/user-groups/create-user-group",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# Create user group
> Creates a [user group](/administration/users/groups). To manage model and connection role assignments for user groups, see the [User group model role APIs](/api/user-group-model-roles).
## OpenAPI
````yaml /api/openapi.yaml post /scim/v2/groups
openapi: 3.1.0
info:
title: Omni API
description: >
The Omni REST API provides programmatic access to your Omni instance for
managing users, documents, queries, schedules, and more.
version: 1.0.0
contact:
name: Omni Support
url: https://docs.omni.co
servers:
- url: https://{instance}.omniapp.co/api
description: Production
variables:
instance:
default: blobsrus
description: Your production Omni instance subdomain
- url: https://{instance}.playground.exploreomni.dev/api
description: Playground
variables:
instance:
default: blobsrus
description: Your playground Omni instance subdomain
security:
- bearerAuth: []
- orgApiKey: []
tags:
- name: AI
description: AI-powered query generation
- name: API Tokens
description: >-
Manage API tokens (Organization keys, Personal Access Tokens, MCP OAuth
grants)
- name: Connections
description: Manage database connections
- name: Connection environments
description: Manage connection environments database connections
- name: Content
description: Unified content retrieval (documents and folders)
- name: Content migration
description: Export and import dashboards
- name: Content validator
description: Validate content against models and perform find/replace operations
- name: Dashboard downloads
description: Download dashboards and tiles as PDF, PNG, XLSX, CSV, or JSON files
- name: Dashboard filters and controls
description: Read and update dashboard filter and control default values
- name: dbt
description: Manage dbt configuration for connections
- name: Documents
description: Create, retrieve, and manage documents
- name: Document favorites
description: Favorite and unfavorite documents
- name: Document labels
description: Apply and manage labels on documents
- name: Document permissions
description: Manage document-level access
- name: Labels
description: >
Manage labels in an organization. Labels can be applied to documents and
folders to help organize and categorize content.
**Label types:**
- **Basic labels**: Can be created and managed by any user
- **Verified labels**: Indicate curated or officially sanctioned content.
Admin-only.
- **Homepage labels**: Appear on the organization homepage. Admin-only.
- name: Folders
description: Create and organize content folders
- name: Folder permissions
description: Manage folder-level access
- name: Jobs
description: Check status of asynchronous jobs
- name: Models
description: Create and manage data models
- name: Model branches
description: Manage model branches and merge changes
- name: Model git configuration
description: Manage git configuration for shared models
- name: Queries
description: Execute workbook queries
- name: Schedules
description: Create and manage scheduled tasks
- name: Schedule recipients
description: Manage schedule recipients
- name: Schema refresh schedules
description: Manage automated schema refresh schedules for connections
- name: Topics
description: Retrieve topic information from models
- name: Uploads
description: Manage file uploads
- name: Users
description: Manage users
- name: User attributes
description: Manage user attribute definitions
- name: User groups
description: Manage user groups
- name: User model roles
description: Manage model and connection role assignments for users
- name: User group model roles
description: Manage model and connection role assignments for user groups
- name: Uploads
description: Manage CSV and spreadsheet uploads
paths:
/scim/v2/groups:
post:
tags:
- User groups
summary: Create user group
description: >
Creates a [user group](/administration/users/groups). To manage model
and connection role assignments for user groups, see the [User group
model role APIs](/api/user-group-model-roles).
operationId: createUserGroup
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- displayName
properties:
displayName:
type: string
description: The name of the group. Names must be 64 characters or less.
example: Blob Sales
members:
type: array
description: >-
A list of users to add as group members. Each member should
be specified as an object containing a user ID.
items:
type: object
properties:
value:
type: string
description: The user's unique identifier
example:
- value: 9e8719d9-276a-4964-9395-a493189a247c
responses:
'201':
description: Group created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ScimGroup'
example:
displayName: Blob Sales
id: mEhXj6ZI
meta:
created: '2024-12-04T00:08:03.250Z'
lastModified: '2024-12-04T00:08:03.250Z'
resourceType: Group
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
members:
- display: blob.ross@blobsrus.co
value: 9e8719d9-276a-4964-9395-a493189a247c
'429':
$ref: '#/components/responses/TooManyRequests'
security:
- orgApiKey: []
components:
schemas:
ScimGroup:
type: object
properties:
id:
type: string
description: Unique identifier for the group
displayName:
type: string
description: The name of the group
members:
type: array
description: The list of users in the group
items:
type: object
properties:
value:
type: string
description: The user's unique identifier
display:
type: string
description: The user's email address
meta:
type: object
description: Metadata about the group resource
properties:
resourceType:
type: string
example: Group
description: The type of resource. This will be `Group`.
created:
type: string
format: date-time
description: The time the group was created
lastModified:
type: string
format: date-time
description: The time the group was last updated
schemas:
type: array
description: SCIM schema information for the group
items:
type: string
Error:
type: object
properties:
error:
type: string
description: HTTP response code for the error
example:
message:
type: string
description: Detailed error description
example:
responses:
TooManyRequests:
description: Too Many Requests - Rate limit exceeded (60 requests/minute)
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Can be either an [Organization API
Key](/api/authentication#organization-api-keys) or [Personal Access
Token (PAT)](/api/authentication#personal-access-tokens-pat).
Include in the `Authorization` header as: `Bearer YOUR_TOKEN`
orgApiKey:
type: http
scheme: bearer
bearerFormat: JWT
description: >
Requires an [Organization API
Key](/api/authentication#organization-api-keys). Personal Access Tokens
(PATs) are not supported for this endpoint.
Include in the `Authorization` header as: `Bearer ORGANIZATION_API_KEY`
````