--- title: List User Groups --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [IAM](https://developers.cloudflare.com/api/python/resources/iam) [User Groups](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List User Groups iam.user\_groups.list(UserGroupListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[UserGroupListResponse]()] 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

##### Accepted Permissions (at least one required) `SCIM Provisioning``Account Settings Write``Account Settings Read` ##### ParametersExpand Collapse account\_id: str 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)>) id: Optional\[str] 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\[Literal\["asc", "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)>) fuzzy\_name: Optional\[str] 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\[str] 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\[float] 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\[float] 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

class UserGroupListResponse: … A group of policies resources.

id: str User Group identifier tag. maxLength32 minLength32 Link to this property created\_on: datetime Timestamp for the creation of the user group formatdate-time Link to this property modified\_on: datetime Last time the user group was modified. formatdate-time Link to this property name: str Name of the user group. Link to this property

policies: Optional\[List\[Policy]] Policies attached to the User group

id: Optional\[str] Policy identifier. Link to this property

access: Optional\[Literal\["allow", "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\[List\[PolicyPermissionGroup]] A set of permission groups that are specified to the policy.

id: str Identifier of the permission group. Link to this property

meta: Optional\[PolicyPermissionGroupMeta] Attributes associated to the permission group.

category: Optional\[str] A category used to group permission groups. Link to this property deprecated: Optional\[str] Indicates whether the permission group is deprecated. Link to this property description: Optional\[str] Additional information about the permission group. Link to this property editable: Optional\[str] Indicates whether the permission group can be edited. Link to this property eol\_at: Optional\[datetime] The planned end-of-life date and time, when provided. formatdate-time Link to this property label: Optional\[str] A label identifying the permission group. Link to this property scopes: Optional\[str] The scope associated with the permission group. Link to this property visibility: Optional\[str] Indicates the permission group’s availability or visibility. Link to this property

Link to this property name: Optional\[str] Name of the permission group. Link to this property

Link to this property

resource\_groups: Optional\[List\[PolicyResourceGroup]] A list of resource groups that the policy applies to.

id: str Identifier of the resource group. Link to this property

scope: PolicyResourceGroupScope A scope is a combination of scope objects which provides additional context.

key: str This is a combination of pre-defined resource name and identifier (like Account ID etc.) Link to this property

objects: List\[PolicyResourceGroupScopeObject] A list of scope objects for additional context.

key: str This is a combination of pre-defined resource name and identifier (like Zone ID etc.) Link to this property

Link to this property

meta: Optional\[PolicyResourceGroupMeta] Attributes associated to the resource group.

key: Optional\[str] Link to this property value: Optional\[str] Link to this property

Link to this property name: Optional\[str] Name of the resource group. Link to this property

Link to this property

[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(model)%20user_group_list_response%20%3E%20(schema)>) ### List User Groups Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_email=os.environ.get("CLOUDFLARE_EMAIL"), # This is the default and can be omitted api_key=os.environ.get("CLOUDFLARE_API_KEY"), # This is the default and can be omitted ) page = client.iam.user_groups.list( account_id="023e105f4ecef8ad9ca31a8372d0c353", ) page = page.result[0] print(page.id) ``` 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 } } ```