Update user group.

Update the details of a user group. You must have either admin or user groups permission to be able to modify user groups. Note you cannot update the ResetPassword permission with this endpoint. For that you need to use Admin API. When updating a user group you also need to specify at least one permission in the user_permissions field.

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Path Parameters

groupId · string · required

ID of the group you want to update.

Body

application/json

active · boolean

Example:

true

description · string

Example:

"Devops logs and analytics access"

id · string

Example:

"6649986d5715ec4c96cbef2b"

name · string

Example:

"66498cd1e2fcd1000184ecb8"

org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

password_max_days · integer

Example:

0

user_permissions · object

Show child attributes

Response

200

application/json

OK

ID · string

Message · string

Meta · any

Status · string