---
title: List User Groups
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[IAM](https://developers.cloudflare.com/api/resources/iam)
[User Groups](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# List User Groups
GET/accounts/{account\_id}/iam/user\_groups
List all the user groups for an account.
##### Security
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required)
`SCIM Provisioning``Account Settings Write``Account Settings Read`
##### P ath ParametersExpand Collapse
account\_id: string
Account identifier tag.
maxLength32
minLength32
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
##### Q uery ParametersExpand Collapse
id: optional string
ID of the user group to be fetched.
maxLength32
minLength32
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>)
direction: optional "asc"or "desc"
The sort order of returned user groups by name (ascending or descending).
One of the following:
"asc"
Link to this property
"desc"
Link to this property
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20direction%20%3E%20(schema)>)
fuzzyName: optional string
A string used for searching for user groups containing that substring.
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20fuzzyName%20%3E%20(schema)>)
name: optional string
Name of the user group to be fetched.
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)
page: optional number
Page number of paginated results.
minimum1
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>)
per\_page: optional number
Maximum number of results per page.
maximum500
minimum1
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional array of object {id, created\_on, modified\_on, 2 more }
A list of user groups for the account.
id: string
User Group identifier tag.
maxLength32
minLength32
Link to this property
created\_on: string
Timestamp for the creation of the user group
formatdate-time
Link to this property
modified\_on: string
Last time the user group was modified.
formatdate-time
Link to this property
name: string
Name of the user group.
Link to this property
policies: optional array of object {id, access, permission\_groups, resource\_groups }
Policies attached to the User group
id: optional string
Policy identifier.
Link to this property
access: optional "allow"or "deny"
Allow or deny operations against the resources.
One of the following:
"allow"
Link to this property
"deny"
Link to this property
Link to this property
permission\_groups: optional array of object {id, meta, name }
A set of permission groups that are specified to the policy.
id: string
Identifier of the permission group.
Link to this property
meta: optional object {category, deprecated, description, 5 more }
Attributes associated to the permission group.
category: optional string
A category used to group permission groups.
Link to this property
deprecated: optional string
Indicates whether the permission group is deprecated.
Link to this property
description: optional string
Additional information about the permission group.
Link to this property
editable: optional string
Indicates whether the permission group can be edited.
Link to this property
eol\_at: optional string
The planned end-of-life date and time, when provided.
formatdate-time
Link to this property
label: optional string
A label identifying the permission group.
Link to this property
scopes: optional string
The scope associated with the permission group.
Link to this property
visibility: optional string
Indicates the permission group’s availability or visibility.
Link to this property
Link to this property
name: optional string
Name of the permission group.
Link to this property
Link to this property
resource\_groups: optional array of object {id, scope, meta, name }
A list of resource groups that the policy applies to.
id: string
Identifier of the resource group.
Link to this property
scope: object {key, objects }
A scope is a combination of scope objects which provides additional context.
key: string
This is a combination of pre-defined resource name and identifier (like Account ID etc.)
Link to this property
objects: array of object {key }
A list of scope objects for additional context.
key: string
This is a combination of pre-defined resource name and identifier (like Zone ID etc.)
Link to this property
Link to this property
Link to this property
meta: optional object {key, value }
Attributes associated to the resource group.
key: optional string
Link to this property
value: optional string
Link to this property
Link to this property
name: optional string
Name of the resource group.
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
result\_info: optional object {count, page, per\_page, total\_count }
count: optional number
Total number of results for the requested service
Link to this property
page: optional number
Current page within paginated list of results
Link to this property
per\_page: optional number
Number of results per page of results
Link to this property
total\_count: optional number
Total results available without any search parameters
Link to this property
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### List User Groups
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/iam/user_groups \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"created_on": "2024-03-01T12:21:02Z",
"modified_on": "2024-03-01T12:21:02Z",
"name": "My New User Group",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"access": "allow",
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"meta": {
"category": "category",
"deprecated": "deprecated",
"description": "description",
"editable": "editable",
"eol_at": "2019-12-27T18:11:19.117Z",
"label": "load_balancer_admin",
"scopes": "com.cloudflare.api.account",
"visibility": "visibility"
},
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"meta": {
"category": "category",
"deprecated": "deprecated",
"description": "description",
"editable": "editable",
"eol_at": "2019-12-27T18:11:19.117Z",
"label": "fbm_user",
"scopes": "com.cloudflare.api.account",
"visibility": "visibility"
},
"name": "Magic Network Monitoring"
}
],
"resource_groups": [
{
"id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
"scope": {
"key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
"objects": [
{
"key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
}
]
},
"meta": {
"key": "key",
"value": "value"
},
"name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
}
]
}
]
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"created_on": "2024-03-01T12:21:02Z",
"modified_on": "2024-03-01T12:21:02Z",
"name": "My New User Group",
"policies": [
{
"id": "f267e341f3dd4697bd3b9f71dd96247f",
"access": "allow",
"permission_groups": [
{
"id": "c8fed203ed3043cba015a93ad1616f1f",
"meta": {
"category": "category",
"deprecated": "deprecated",
"description": "description",
"editable": "editable",
"eol_at": "2019-12-27T18:11:19.117Z",
"label": "load_balancer_admin",
"scopes": "com.cloudflare.api.account",
"visibility": "visibility"
},
"name": "Zone Read"
},
{
"id": "82e64a83756745bbbb1c9c2701bf816b",
"meta": {
"category": "category",
"deprecated": "deprecated",
"description": "description",
"editable": "editable",
"eol_at": "2019-12-27T18:11:19.117Z",
"label": "fbm_user",
"scopes": "com.cloudflare.api.account",
"visibility": "visibility"
},
"name": "Magic Network Monitoring"
}
],
"resource_groups": [
{
"id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
"scope": {
"key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
"objects": [
{
"key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
}
]
},
"meta": {
"key": "key",
"value": "value"
},
"name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
}
]
}
]
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}
```