Skip to main content
PUT
/
api
/
security
/
user-group
Updates an existing user group (super admin only, system groups cannot be deleted via update).
curl --request PUT \
  --url https://{install}/api/security/user-group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "type": 123,
  "member": [
    "<string>"
  ],
  "tenantId": "<string>",
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "deleted": true
}
'

Authorizations

​
Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

The user group with updated values.

​
entity
null | string
​
name
string
​
description
string
​
type
integer
​
member
string[]
​
tenantId
string
​
id
string
​
created
string<date-time>
​
createdBy
string
​
updated
string<date-time>
​
updatedBy
string
​
deleted
boolean

Response

User group updated successfully.