--- title: Create User Group --- [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** # Create User Group client.IAM.UserGroups.New(ctx, params) (\*[UserGroupNewResponse](), error) POST/accounts/{account\_id}/iam/user\_groups Create a new user group under the specified 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` ##### Accepted Permissions (at least one required) `SCIM Provisioning``Account Settings Write` ##### ParametersExpand Collapse

params UserGroupNewParams

AccountID param.Field\[string] Path param: Account identifier tag. maxLength32 minLength32 Link to this property Name param.Field\[string] Body param: Name of the User group. Link to this property

Policies param.Field\[\[]UserGroupNewParamsPolicy]Optional Body param: Policies attached to the User group

Access UserGroupNewParamsPoliciesAccess Allow or deny operations against the resources.

One of the following: const UserGroupNewParamsPoliciesAccessAllow UserGroupNewParamsPoliciesAccess = "allow" Link to this property const UserGroupNewParamsPoliciesAccessDeny UserGroupNewParamsPoliciesAccess = "deny" Link to this property

Link to this property

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

ID string Permission Group identifier tag. maxLength32 minLength32 Link to this property

Link to this property

ResourceGroups \[]UserGroupNewParamsPoliciesResourceGroup A set of resource groups that are specified to the policy.

ID string Resource Group identifier tag. maxLength32 minLength32 Link to this property

Link to this property

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

type UserGroupNewResponse 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 \[]UserGroupNewResponsePolicyOptional Policies attached to the User group

ID stringOptional Policy identifier. Link to this property

Access UserGroupNewResponsePoliciesAccessOptional Allow or deny operations against the resources.

One of the following: const UserGroupNewResponsePoliciesAccessAllow UserGroupNewResponsePoliciesAccess = "allow" Link to this property const UserGroupNewResponsePoliciesAccessDeny UserGroupNewResponsePoliciesAccess = "deny" Link to this property

Link to this property

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

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

Meta UserGroupNewResponsePoliciesPermissionGroupsMetaOptional 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 \[]UserGroupNewResponsePoliciesResourceGroupOptional A list of resource groups that the policy applies to.

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

Scope UserGroupNewResponsePoliciesResourceGroupsScope 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 \[]UserGroupNewResponsePoliciesResourceGroupsScopeObject 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 UserGroupNewResponsePoliciesResourceGroupsMetaOptional 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)%20UserGroupNewResponse%20%3E%20(schema)>) ### Create User Group 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"), ) userGroup, err := client.IAM.UserGroups.New(context.TODO(), iam.UserGroupNewParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Name: cloudflare.F("My New User Group"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", userGroup.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" } ] } ] } } ``` ##### 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" } ] } ] } } ```