---
title: "Create User Group"
method: POST
path: "/api/v2/core/user-groups"
tags: ["User Groups"]
---

# Create User Group

`POST /api/v2/core/user-groups`

## Request

- Base URL: `https://apiv2.eightfold.ai`
- URL: `https://apiv2.eightfold.ai/api/v2/core/user-groups`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/core/user-groups/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a user group. userGroupName must be unique within the tenant, ignoring case and surrounding whitespace. Access criteria and dynamic membership rules cannot be set through this API. Members are assigned through the user group membership APIs.

## Headers

- `Authorization` string, required

## Request body

- UserGroupCreateSchema
  - `createdAt` integer, nullable: Create timestamp of the user group
  - `id` integer, nullable: Id of the user group
  - `isActive` boolean: Whether the user group is active
  - `description` string, nullable: Description of the user group
  - `productLine` string, nullable: Product line this user group applies to. Defaults to all product lines
  - `updatedAt` integer, nullable: Update timestamp of the user group
  - `role` string, nullable: Role granted to the members of the user group
  - `userGroupName` string, required: Name of the user group. Must be unique within the tenant, ignoring case

## Response `200`

OK

- UserGroupBaseSchema
  - `createdAt` integer, nullable: Create timestamp of the user group
  - `id` integer, nullable: Id of the user group
  - `isActive` boolean, nullable: Whether the user group is active
  - `description` string, nullable: Description of the user group
  - `productLine` string, nullable: Product line this user group applies to. Defaults to all product lines
  - `updatedAt` integer, nullable: Update timestamp of the user group
  - `role` string, nullable: Role granted to the members of the user group
  - `userGroupName` string, nullable: Name of the user group

## Changes

- **2026-11-03** `9a8b3a927e93`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/changes/api/v2/core/user-groups/post.md)

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) - [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) - [OpenAPI document](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/revisions/9a8b3a927e93?raw)