List user groups.

This will return a list of all the user groups. The returned user groups are paginated.

GET /api/usergroups

Try it

List user groups.

cURL

curl --request GET \
  --url https://{tenant}/api/usergroups \
  --header 'Authorization: Bearer <token>'

200

{
  "groups": [
    {
      "active": true,
      "description": "Devops logs and analytics access",
      "id": "6649986d5715ec4c96cbef2b",
      "name": "66498cd1e2fcd1000184ecb8",
      "org_id": "5e9d9544a1dcd60001d0ed20",
      "password_max_days": 0,
      "user_permissions": {}
    }
  ],
  "pages": 123
}

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

200

application/json

User groups fetched.

groups · object[] | null

Show child attributes

groups. active · boolean

Example:

true

groups. description · string

Example:

"Devops logs and analytics access"

groups. id · string

Example:

"6649986d5715ec4c96cbef2b"

groups. name · string

Example:

"66498cd1e2fcd1000184ecb8"

groups. org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

groups. password_max_days · integer

Example:

0

groups. user_permissions · object

Show child attributes

groups.user_permissions. {key} · string

pages · integer