GET
/
api
/
usergroups
List user groups.
curl --request GET \
  --url https://{tenant}/api/usergroups \
  --header 'Authorization: Bearer <token>'
{
  "groups": [
    {
      "active": true,
      "description": "devs company",
      "id": "363634393938366435373135656334633936636265663262",
      "name": "devs",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "password_max_days": 0,
      "user_permissions": {
        "analytics": "read",
        "api_assets": "write",
        "apis": "write",
        "certs": "write",
        "hooks": "write",
        "idm": "write",
        "keys": "write",
        "log": "read",
        "oauth": "write",
        "owned_analytics": "deny",
        "policies": "write",
        "portal": "write",
        "system": "write",
        "user_groups": "write",
        "users": "write",
        "websockets": "read"
      }
    },
    {
      "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"
      }
    }
  ],
  "pages": 1
}

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

​
p
integer

Use p query parameter to say which page you want returned. Send number less than 0 to return all items.

Response

User groups fetched.

​
groups
object[] | null
​
pages
integer