Skip to main content
GET
/
api
/
usergroups
/
{groupId}
Get user group details.
curl --request GET \
  --url https://{tenant}/api/usergroups/{groupId} \
  --header 'Authorization: Bearer <token>'
{
  "active": true,
  "description": "Devops logs and analytics access",
  "id": "363634396664346235373135656334633936636265663338",
  "name": "Devops",
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "password_max_days": 0,
  "user_permissions": {
    "analytics": "read",
    "log": "read"
  }
}

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

​
groupId
string
required

ID of the group you want to fetch.

Response

User grouped fetched.

​
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