Update a group

PUT /api/admin/groups/:groupId

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

Request

Path Parameters

groupId string required

application/json

Body

required

createGroupSchema

name string required
The name of the group
description string nullable
A custom description of the group
mappingsSSO string[]
A list of SSO groups that should map to this Unleash group
rootRole number nullable
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.
users object[]
A list of users belonging to this group
Array [
user objectrequired
A minimal user object
id integer required
The user id
]

Responses

groupSchema

application/json

Schema
Example (from schema)

Schema

id integer
The group id
name string required
The name of the group
description string nullable
A custom description of the group
mappingsSSO string[]
A list of SSO groups that should map to this Unleash group
rootRole number nullable
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.
createdBy string nullable
A user who created this group
createdAt date-time nullable
When was this group created
users object[]
A list of users belonging to this group
Array [
joinedAt date-time
The date when the user joined the group
createdBy string nullable
The username of the user who added this user to this group
user objectrequired
An Unleash user
id integer required
The user id
isAPI boolean deprecated
Deprecated in v5. Used internally to know which operations the user should be allowed to perform
name string nullable
Name of the user
email string
Email of the user
username string nullable
A unique username for the user
imageUrl string
URL used for the user profile image
inviteLink string
If the user is actively inviting other users, this is the link that can be shared with other users
loginAttempts integer
How many unsuccessful attempts at logging in has the user made
emailSent boolean
Is the welcome email sent to the user or not
rootRole integer
Which root role this user is assigned
seenAt date-time nullable
The last time this user logged in
createdAt date-time
The user was created at this time
accountType string
A user is either an actual User or a Service Account
permissions string[]
Deprecated
scimId string nullable
The SCIM ID of the user, only present if managed by SCIM
]
projects string[]
A list of projects where this group is used
userCount integer
The number of users that belong to this group
scimId string nullable
The SCIM ID of the group, only present if managed by SCIM

{
  "id": 1,
  "name": "DX team",
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "createdBy": "admin",
  "createdAt": "2023-06-30T11:41:00.123Z",
  "users": [
    {
      "joinedAt": "2023-06-30T11:41:00.123Z",
      "createdBy": "admin",
      "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"
      }
    }
  ],
  "projects": [
    "default",
    "my-project"
  ],
  "userCount": 1,
  "scimId": "01HTMEXAMPLESCIMID7SWWGHN7"
}

The request data does not match what we expect.

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

The requested resource was not found.

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

application/json

Schema
Example (from schema)

Schema

id string
The ID of the error instance
name string
The name of the error kind
message string
A description of what went wrong.

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NameExistsError",
  "message": "There is already a feature called \"my-awesome-feature\"."
}

Update a group

Request​

Path Parameters

Body

Request