Update a group

Renames the group and replaces its members. Set is_admin to grant admin privileges to the group's members.

put

Authorizations

cookieapi_token

defguard_sessionstringRequired

Path parameters

idinteger · int64Required

ID of the group.

Body

application/json

Dedicated GroupInfo variant for group modification operations.

is_adminbooleanRequired

membersstring[]Required

namestringRequired

Responses

200

Group updated.

No content

400

Cannot remove admin permissions from the last admin group.

401

Session is missing or invalid.

application/json

403

Requires admin privileges.

application/json

404

User or group not found.

application/json

500

Unable to update group.

application/json

put/api/v1/group/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/group/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "is_admin": true,
  "members": [
    "text"
  ],
  "name": "text"
}

No content