--- title: User Groups --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [IAM](https://developers.cloudflare.com/api/python/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/python/resources/iam/subresources/user_groups/methods/list) iam.user\_groups.list(UserGroupListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[UserGroupListResponse]()] GET/accounts/{account\_id}/iam/user\_groups ##### [User Group Details](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/methods/get) iam.user\_groups.get(struser\_group\_id, UserGroupGetParams\*\*kwargs) -> [UserGroupGetResponse]() GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### [Create User Group](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/methods/create) iam.user\_groups.create(UserGroupCreateParams\*\*kwargs) -> [UserGroupCreateResponse]() POST/accounts/{account\_id}/iam/user\_groups ##### [Update User Group](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/methods/update) iam.user\_groups.update(struser\_group\_id, UserGroupUpdateParams\*\*kwargs) -> [UserGroupUpdateResponse]() PUT/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### [Remove User Group](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/methods/delete) iam.user\_groups.delete(struser\_group\_id, UserGroupDeleteParams\*\*kwargs) -> [UserGroupDeleteResponse]() DELETE/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### ModelsExpand 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
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
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(model)%20user_group_list_response%20%3E%20(schema)>)
class UserGroupGetResponse: … 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
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
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(model)%20user_group_get_response%20%3E%20(schema)>)
class UserGroupCreateResponse: … 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
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
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(model)%20user_group_create_response%20%3E%20(schema)>)
class UserGroupUpdateResponse: … 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
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
[Link to this property](<#(resource)%20iam.user_groups%20%3E%20(model)%20user_group_update_response%20%3E%20(schema)>)
class UserGroupDeleteResponse: … id: str 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/python/resources/iam/subresources/user_groups/subresources/members/methods/list) iam.user\_groups.members.list(struser\_group\_id, MemberListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[MemberListResponse]()] GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Get User Group Member](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/subresources/members/methods/get) iam.user\_groups.members.get(strmember\_id, MemberGetParams\*\*kwargs) -> [MemberGetResponse]() GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members/{member\_id} ##### [Add User Group Members](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/subresources/members/methods/create) iam.user\_groups.members.create(struser\_group\_id, MemberCreateParams\*\*kwargs) -> SyncSinglePage\[[MemberCreateResponse]()] POST/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Update User Group Members](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/subresources/members/methods/update) iam.user\_groups.members.update(struser\_group\_id, MemberUpdateParams\*\*kwargs) -> SyncSinglePage\[[MemberUpdateResponse]()] PUT/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Remove User Group Member](https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups/subresources/members/methods/delete) iam.user\_groups.members.delete(strmember\_id, MemberDeleteParams\*\*kwargs) -> [MemberDeleteResponse]() DELETE/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members/{member\_id} ##### ModelsExpand Collapse
class MemberListResponse: … Member attached to a User Group. id: str Account member identifier. Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
status: Optional\[Literal\["accepted", "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)>)
class MemberGetResponse: … Detailed member information for a User Group member. id: str Account member identifier. Link to this property created\_at: Optional\[datetime] When the member was added to the user group. formatdate-time Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
status: Optional\[Literal\["accepted", "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\[User] Details of the user associated with this membership. id: Optional\[str] User identifier tag. Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property first\_name: Optional\[str] User’s first name. Link to this property last\_name: Optional\[str] 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)>)
class MemberCreateResponse: … Member attached to a User Group. id: str Account member identifier. Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
status: Optional\[Literal\["accepted", "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)>)
class MemberUpdateResponse: … Member attached to a User Group. id: str Account member identifier. Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
status: Optional\[Literal\["accepted", "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)>)
class MemberDeleteResponse: … Member attached to a User Group. id: str Account member identifier. Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
status: Optional\[Literal\["accepted", "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)>)