--- title: User Groups --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [IAM](https://developers.cloudflare.com/api/resources/iam) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # User Groups ##### [List User Groups](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/methods/list) GET/accounts/{account\_id}/iam/user\_groups ##### [User Group Details](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/methods/get) GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### [Create User Group](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/methods/create) POST/accounts/{account\_id}/iam/user\_groups ##### [Update User Group](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/methods/update) PUT/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### [Remove User Group](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/methods/delete) DELETE/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### ModelsExpand Collapse
UserGroupListResponse object {id, created\_on, modified\_on, 2 more } A group of policies resources. 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(model)%20user_group_list_response%20%3E%20(schema)>)
UserGroupGetResponse object {id, created\_on, modified\_on, 2 more } A group of policies resources. 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(model)%20user_group_get_response%20%3E%20(schema)>)
UserGroupCreateResponse object {id, created\_on, modified\_on, 2 more } A group of policies resources. 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(model)%20user_group_create_response%20%3E%20(schema)>)
UserGroupUpdateResponse object {id, created\_on, modified\_on, 2 more } A group of policies resources. 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(model)%20user_group_update_response%20%3E%20(schema)>)
UserGroupDeleteResponse object {id } id: string Identifier maxLength32 minLength32 Link to this property
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(model)%20user_group_delete_response%20%3E%20(schema)>) #### User GroupsMembers ##### [List User Group Members](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/subresources/members/methods/list) GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Get User Group Member](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/subresources/members/methods/get) GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members/{member\_id} ##### [Add User Group Members](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/subresources/members/methods/create) POST/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Update User Group Members](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/subresources/members/methods/update) PUT/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Remove User Group Member](https://developers.cloudflare.com/api/resources/iam/subresources/user_groups/subresources/members/methods/delete) DELETE/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members/{member\_id} ##### ModelsExpand Collapse
MemberListResponse object {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
status: optional "accepted"or "pending" The member’s status in the account. One of the following: "accepted" Link to this property "pending" Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups.members%20%3E%20(model)%20member_list_response%20%3E%20(schema)>)
MemberGetResponse object {id, created\_at, email, 2 more } Detailed member information for a User Group member. id: string Account member identifier. Link to this property created\_at: optional string When the member was added to the user group. formatdate-time Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
status: optional "accepted"or "pending" The member’s status in the account. One of the following: "accepted" Link to this property "pending" Link to this property
Link to this property
user: optional object {id, email, first\_name, last\_name } Details of the user associated with this membership. id: optional string User identifier tag. Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property first\_name: optional string User’s first name. Link to this property last\_name: optional string User’s last name. Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups.members%20%3E%20(model)%20member_get_response%20%3E%20(schema)>)
MemberCreateResponse object {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
status: optional "accepted"or "pending" The member’s status in the account. One of the following: "accepted" Link to this property "pending" Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups.members%20%3E%20(model)%20member_create_response%20%3E%20(schema)>)
MemberUpdateResponse object {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
status: optional "accepted"or "pending" The member’s status in the account. One of the following: "accepted" Link to this property "pending" Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups.members%20%3E%20(model)%20member_update_response%20%3E%20(schema)>)
MemberDeleteResponse object {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
status: optional "accepted"or "pending" The member’s status in the account. One of the following: "accepted" Link to this property "pending" Link to this property
Link to this property
[Link to this property](<#(resource)%20iam.user_groups.members%20%3E%20(model)%20member_delete_response%20%3E%20(schema)>)