Update a group | Unleash Documentation

curl -X PUT https://app.unleash-instance.example.com/api/admin/groups/groupId \
     -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",
        "companyRole": "Developer",
        "productUpdatesEmailConsent": false,
        "activeSessions": 2,
        "deletedSessions": 1
      },
      "joinedAt": "2023-06-30T11:41:00.123Z",
      "createdBy": "admin"
    }
  ],
  "projects": [
    "default",
    "my-project"
  ],
  "userCount": 1,
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}

Enterprise feature

Update existing user group by group id. It overrides previous group details.

curl -X PUT https://app.unleash-instance.example.com/api/admin/groups/groupId \
     -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",
        "companyRole": "Developer",
        "productUpdatesEmailConsent": false,
        "activeSessions": 2,
        "deletedSessions": 1
      },
      "joinedAt": "2023-06-30T11:41:00.123Z",
      "createdBy": "admin"
    }
  ],
  "projects": [
    "default",
    "my-project"
  ],
  "userCount": 1,
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}

Enterprise feature

Update existing user group by group id. It overrides previous group details.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

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

Path parameters

groupIdstringRequired

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

groupSchema

namestring

The name of the group

idinteger

The group id

descriptionstring or null

A custom description of the group

mappingsSSOlist of strings

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

A list of users belonging to this group

projectslist of strings

A list of projects where this group is used

userCountinteger>=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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

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

1	{
2	"name": "DX team",
3	"id": 1,
4	"description": "Current members of the DX squad",
5	"mappingsSSO": [
6	"SSOGroup1",
7	"SSOGroup2"
8	],
9	"rootRole": 1,
10	"createdBy": "admin",
11	"createdAt": "2023-06-30T11:41:00.123Z",
12	"users": [
13	{
14	"user": {
15	"id": 123,
16	"name": "User",
17	"email": "user@example.com",
18	"username": "hunter",
19	"imageUrl": "https://example.com/242x200.png",
20	"inviteLink": "http://localhost:4242/invite-link/some-secret",
21	"loginAttempts": 3,
22	"emailSent": false,
23	"rootRole": 1,
24	"seenAt": "2023-06-30T11:42:00.345Z",
25	"createdAt": "2023-06-30T11:41:00.123Z",
26	"accountType": "User",
27	"permissions": [
28	"string"
29	],
30	"scimId": "01HTMEXAMPLESCIMID7SWWGHN6",
31	"seatType": "Regular",
32	"companyRole": "Developer",
33	"productUpdatesEmailConsent": false,
34	"activeSessions": 2,
35	"deletedSessions": 1
36	},
37	"joinedAt": "2023-06-30T11:41:00.123Z",
38	"createdBy": "admin"
39	}
40	],
41	"projects": [
42	"default",
43	"my-project"
44	],
45	"userCount": 1,
46	"scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
47	}