Update a group

PUT 
<your-unleash-url>/api/admin/groups/:groupId

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

Request

Responses

200

groupSchema

400

The request data does not match what we expect.

401

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

403

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

404

The requested resource was not found.

409

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.

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT '<your-unleash-url>/api/admin/groups/:groupId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
-d '{
  "name": "DX team",
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "users": [
    {
      "user": {
        "id": 123
      }
    }
  ]
}'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

groupId — pathrequired

Body required

{
  "name": "DX team",
  "description": "Current members of the DX squad",
  "mappingsSSO": [
    "SSOGroup1",
    "SSOGroup2"
  ],
  "rootRole": 1,
  "users": [
    {
      "user": {
        "id": 123
      }
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!