--- title: User Groups --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [IAM](https://developers.cloudflare.com/api/typescript/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/typescript/resources/iam/subresources/user_groups/methods/list) client.iam.userGroups.list(UserGroupListParams {account\_id, id, direction, 4 more } params, RequestOptionsoptions?): V4PagePaginationArray< [UserGroupListResponse]() {id, created\_on, modified\_on, 2 more } > GET/accounts/{account\_id}/iam/user\_groups ##### [User Group Details](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/methods/get) client.iam.userGroups.get(stringuserGroupID, UserGroupGetParams {account\_id } params, RequestOptionsoptions?): [UserGroupGetResponse]() {id, created\_on, modified\_on, 2 more } GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### [Create User Group](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/methods/create) client.iam.userGroups.create(UserGroupCreateParams {account\_id, name, policies } params, RequestOptionsoptions?): [UserGroupCreateResponse]() {id, created\_on, modified\_on, 2 more } POST/accounts/{account\_id}/iam/user\_groups ##### [Update User Group](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/methods/update) client.iam.userGroups.update(stringuserGroupID, UserGroupUpdateParams {account\_id, name, policies } params, RequestOptionsoptions?): [UserGroupUpdateResponse]() {id, created\_on, modified\_on, 2 more } PUT/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### [Remove User Group](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/methods/delete) client.iam.userGroups.delete(stringuserGroupID, UserGroupDeleteParams {account\_id } params, RequestOptionsoptions?): [UserGroupDeleteResponse]() {id } | null DELETE/accounts/{account\_id}/iam/user\_groups/{user\_group\_id} ##### ModelsExpand Collapse
UserGroupListResponse {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?: Array<Policy> Policies attached to the User group id?: string Policy identifier. Link to this property
access?: "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?: Array<PermissionGroup> A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group. category?: string A category used to group permission groups. Link to this property deprecated?: string Indicates whether the permission group is deprecated. Link to this property description?: string Additional information about the permission group. Link to this property editable?: string Indicates whether the permission group can be edited. Link to this property eol\_at?: string The planned end-of-life date and time, when provided. formatdate-time Link to this property label?: string A label identifying the permission group. Link to this property scopes?: string The scope associated with the permission group. Link to this property visibility?: string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name?: string Name of the permission group. Link to this property
Link to this property
resource\_groups?: Array<ResourceGroup> A list of resource groups that the policy applies to. id: string Identifier of the resource group. Link to this property
scope: Scope {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<Object> 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?: Meta {key, value } Attributes associated to the resource group. key?: string Link to this property value?: string Link to this property
Link to this property name?: 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 {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?: Array<Policy> Policies attached to the User group id?: string Policy identifier. Link to this property
access?: "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?: Array<PermissionGroup> A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group. category?: string A category used to group permission groups. Link to this property deprecated?: string Indicates whether the permission group is deprecated. Link to this property description?: string Additional information about the permission group. Link to this property editable?: string Indicates whether the permission group can be edited. Link to this property eol\_at?: string The planned end-of-life date and time, when provided. formatdate-time Link to this property label?: string A label identifying the permission group. Link to this property scopes?: string The scope associated with the permission group. Link to this property visibility?: string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name?: string Name of the permission group. Link to this property
Link to this property
resource\_groups?: Array<ResourceGroup> A list of resource groups that the policy applies to. id: string Identifier of the resource group. Link to this property
scope: Scope {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<Object> 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?: Meta {key, value } Attributes associated to the resource group. key?: string Link to this property value?: string Link to this property
Link to this property name?: 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 {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?: Array<Policy> Policies attached to the User group id?: string Policy identifier. Link to this property
access?: "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?: Array<PermissionGroup> A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group. category?: string A category used to group permission groups. Link to this property deprecated?: string Indicates whether the permission group is deprecated. Link to this property description?: string Additional information about the permission group. Link to this property editable?: string Indicates whether the permission group can be edited. Link to this property eol\_at?: string The planned end-of-life date and time, when provided. formatdate-time Link to this property label?: string A label identifying the permission group. Link to this property scopes?: string The scope associated with the permission group. Link to this property visibility?: string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name?: string Name of the permission group. Link to this property
Link to this property
resource\_groups?: Array<ResourceGroup> A list of resource groups that the policy applies to. id: string Identifier of the resource group. Link to this property
scope: Scope {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<Object> 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?: Meta {key, value } Attributes associated to the resource group. key?: string Link to this property value?: string Link to this property
Link to this property name?: 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 {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?: Array<Policy> Policies attached to the User group id?: string Policy identifier. Link to this property
access?: "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?: Array<PermissionGroup> A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group. category?: string A category used to group permission groups. Link to this property deprecated?: string Indicates whether the permission group is deprecated. Link to this property description?: string Additional information about the permission group. Link to this property editable?: string Indicates whether the permission group can be edited. Link to this property eol\_at?: string The planned end-of-life date and time, when provided. formatdate-time Link to this property label?: string A label identifying the permission group. Link to this property scopes?: string The scope associated with the permission group. Link to this property visibility?: string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name?: string Name of the permission group. Link to this property
Link to this property
resource\_groups?: Array<ResourceGroup> A list of resource groups that the policy applies to. id: string Identifier of the resource group. Link to this property
scope: Scope {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<Object> 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?: Meta {key, value } Attributes associated to the resource group. key?: string Link to this property value?: string Link to this property
Link to this property name?: 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 {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/typescript/resources/iam/subresources/user_groups/subresources/members/methods/list) client.iam.userGroups.members.list(stringuserGroupID, MemberListParams {account\_id, direction, fuzzyEmail, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray< [MemberListResponse]() {id, email, status } > GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Get User Group Member](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/subresources/members/methods/get) client.iam.userGroups.members.get(stringmemberID, MemberGetParams {account\_id, user\_group\_id } params, RequestOptionsoptions?): [MemberGetResponse]() {id, created\_at, email, 2 more } GET/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members/{member\_id} ##### [Add User Group Members](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/subresources/members/methods/create) client.iam.userGroups.members.create(stringuserGroupID, MemberCreateParams {account\_id, members } params, RequestOptionsoptions?): SinglePage< [MemberCreateResponse]() {id, email, status } > POST/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Update User Group Members](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/subresources/members/methods/update) client.iam.userGroups.members.update(stringuserGroupID, MemberUpdateParams {account\_id, members } params, RequestOptionsoptions?): SinglePage< [MemberUpdateResponse]() {id, email, status } > PUT/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members ##### [Remove User Group Member](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/user_groups/subresources/members/methods/delete) client.iam.userGroups.members.delete(stringmemberID, MemberDeleteParams {account\_id, user\_group\_id } params, RequestOptionsoptions?): [MemberDeleteResponse]() {id, email, status } DELETE/accounts/{account\_id}/iam/user\_groups/{user\_group\_id}/members/{member\_id} ##### ModelsExpand Collapse
MemberListResponse {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email?: string The contact email address of the user. maxLength90 Link to this property
status?: "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)>)
MemberGetResponse {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?: string When the member was added to the user group. formatdate-time Link to this property email?: string The contact email address of the user. maxLength90 Link to this property
status?: "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?: User {id, email, first\_name, last\_name } Details of the user associated with this membership. id?: string User identifier tag. Link to this property email?: string The contact email address of the user. maxLength90 Link to this property first\_name?: string User’s first name. Link to this property last\_name?: 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 {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email?: string The contact email address of the user. maxLength90 Link to this property
status?: "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)>)
MemberUpdateResponse {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email?: string The contact email address of the user. maxLength90 Link to this property
status?: "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)>)
MemberDeleteResponse {id, email, status } Member attached to a User Group. id: string Account member identifier. Link to this property email?: string The contact email address of the user. maxLength90 Link to this property
status?: "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)>)