Create a new group | Unleash Documentation

curl -X POST https://app.unleash-instance.example.com/api/admin/groups \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "DX team"
}'

{
  "name": "DX team",
  "id": 1,
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "createdBy": "admin",
  "createdAt": "2023-06-30T11:41:00.123Z",
  "users": [
    {
      "user": {
        "id": 123,
        "name": "User",
        "email": "user@example.com",
        "username": "hunter",
        "imageUrl": "https://example.com/242x200.png",
        "inviteLink": "http://localhost:4242/invite-link/some-secret",
        "loginAttempts": 3,
        "emailSent": false,
        "rootRole": 1,
        "seenAt": "2023-06-30T11:42:00.345Z",
        "createdAt": "2023-06-30T11:41:00.123Z",
        "accountType": "User",
        "permissions": [
          "string"
        ],
        "scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
        "seatType": "Regular",
        "activeSessions": 2,
        "deletedSessions": 1
      },
      "joinedAt": "2023-06-30T11:41:00.123Z",
      "createdBy": "admin"
    }
  ],
  "projects": [
    "default",
    "my-project"
  ],
  "userCount": 1,
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}

Enterprise feature

Create a new user group for Role-Based Access Control

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Request

createGroupSchema

namestringRequired

The name of the group

descriptionstring or nullOptional

A custom description of the group

mappingsSSOlist of stringsOptional

A list of SSO groups that should map to this Unleash group

rootRoledouble or nullOptional

A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

userslist of objectsOptional

A list of users belonging to this group

Response headers

locationstring or null

The location of the newly created resource.

Response

The resource was successfully created.

namestring

The name of the group

idinteger or null

The group id

descriptionstring or null

A custom description of the group

mappingsSSOlist of strings or null

A list of SSO groups that should map to this Unleash group

rootRoledouble or null

A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.

createdBystring or null

A user who created this group

createdAtstring or nullformat: "date-time"

When was this group created

userslist of objects or null

A list of users belonging to this group

projectslist of strings or null

A list of projects where this group is used

userCountinteger or null>=0

The number of users that belong to this group

scimIdstring or null

The SCIM ID of the group, only present if managed by SCIM

Authentication

Request

Response headers

Response

Errors