--- title: List User Groups --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [IAM](https://developers.cloudflare.com/api/go/resources/iam) [User Groups](https://developers.cloudflare.com/api/go/resources/iam/subresources/user_groups) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List User Groups client.IAM.UserGroups.List(ctx, params) (\*V4PagePaginationArray\[[UserGroupListResponse]()], error) 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

params UserGroupListParams

AccountID param.Field\[string] Path param: Account identifier tag. maxLength32 minLength32 Link to this property ID param.Field\[string]Optional Query param: ID of the user group to be fetched. maxLength32 minLength32 Link to this property

Direction param.Field\[UserGroupListParamsDirection]Optional Query param: The sort order of returned user groups by name (ascending or descending).

const UserGroupListParamsDirectionAsc UserGroupListParamsDirection = "asc" Link to this property const UserGroupListParamsDirectionDesc UserGroupListParamsDirection = "desc" Link to this property

Link to this property FuzzyName param.Field\[string]Optional Query param: A string used for searching for user groups containing that substring. Link to this property Name param.Field\[string]Optional Query param: Name of the user group to be fetched. Link to this property Page param.Field\[float64]Optional Query param: Page number of paginated results. minimum1 Link to this property PerPage param.Field\[float64]Optional Query param: Maximum number of results per page. maximum500 minimum1 Link to this property

[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(method)%20list%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type UserGroupListResponse struct{…} A group of policies resources.

ID string User Group identifier tag. maxLength32 minLength32 Link to this property CreatedOn Time Timestamp for the creation of the user group formatdate-time Link to this property ModifiedOn Time 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 \[]UserGroupListResponsePolicyOptional Policies attached to the User group

ID stringOptional Policy identifier. Link to this property

Access UserGroupListResponsePoliciesAccessOptional Allow or deny operations against the resources.

One of the following: const UserGroupListResponsePoliciesAccessAllow UserGroupListResponsePoliciesAccess = "allow" Link to this property const UserGroupListResponsePoliciesAccessDeny UserGroupListResponsePoliciesAccess = "deny" Link to this property

Link to this property

PermissionGroups \[]UserGroupListResponsePoliciesPermissionGroupOptional A set of permission groups that are specified to the policy.

ID string Identifier of the permission group. Link to this property

Meta UserGroupListResponsePoliciesPermissionGroupsMetaOptional Attributes associated to the permission group.

Category stringOptional A category used to group permission groups. Link to this property Deprecated stringOptional Indicates whether the permission group is deprecated. Link to this property Description stringOptional Additional information about the permission group. Link to this property Editable stringOptional Indicates whether the permission group can be edited. Link to this property EolAt TimeOptional The planned end-of-life date and time, when provided. formatdate-time Link to this property Label stringOptional A label identifying the permission group. Link to this property Scopes stringOptional The scope associated with the permission group. Link to this property Visibility stringOptional Indicates the permission group’s availability or visibility. Link to this property

Link to this property Name stringOptional Name of the permission group. Link to this property

Link to this property

ResourceGroups \[]UserGroupListResponsePoliciesResourceGroupOptional A list of resource groups that the policy applies to.

ID string Identifier of the resource group. Link to this property

Scope UserGroupListResponsePoliciesResourceGroupsScope 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 \[]UserGroupListResponsePoliciesResourceGroupsScopeObject 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

Meta UserGroupListResponsePoliciesResourceGroupsMetaOptional Attributes associated to the resource group.

Key stringOptional Link to this property Value stringOptional Link to this property

Link to this property Name stringOptional 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)%20UserGroupListResponse%20%3E%20(schema)>) ### List User Groups Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/iam" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), option.WithAPIEmail("user@example.com"), ) page, err := client.IAM.UserGroups.List(context.TODO(), iam.UserGroupListParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` 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 } } ```