Skip to main content
PUT
/
api
/
usergroups
/
{groupId}
Update user group.
curl --request PUT \
  --url https://{tenant}/api/usergroups/{groupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "description": "Devops logs and analytics access",
  "name": "Devops",
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "user_permissions": {
    "analytics": "read",
    "log": "read"
  }
}
'
{
  "Message": "User group updated",
  "Meta": null,
  "Status": "OK"
}

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Response

OK

ID
string
Message
string
Meta
any
Status
string