---
title: Resource 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**

# Resource Groups

##### [List Resource Groups](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/resource_groups/methods/list)

client.iam.resourceGroups.list(ResourceGroupListParams {account\_id, id, name } params, RequestOptionsoptions?): SinglePage< [ResourceGroupListResponse](<https://developers.cloudflare.com/api/typescript/resources/iam#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)>) {id, scope, meta, name } >

GET/accounts/{account\_id}/iam/resource\_groups

##### [Resource Group Details](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/resource_groups/methods/get)

client.iam.resourceGroups.get(stringresourceGroupID, ResourceGroupGetParams {account\_id } params, RequestOptionsoptions?): [ResourceGroupGetResponse](<https://developers.cloudflare.com/api/typescript/resources/iam#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)>) {id, scope, meta, name }

GET/accounts/{account\_id}/iam/resource\_groups/{resource\_group\_id}

##### [Create Resource Group](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/resource_groups/methods/create)

client.iam.resourceGroups.create(ResourceGroupCreateParams {account\_id, name, scope } params, RequestOptionsoptions?): [ResourceGroupCreateResponse](<https://developers.cloudflare.com/api/typescript/resources/iam#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)>) {id, scope, meta, name }

POST/accounts/{account\_id}/iam/resource\_groups

##### [Update Resource Group](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/resource_groups/methods/update)

client.iam.resourceGroups.update(stringresourceGroupID, ResourceGroupUpdateParams {account\_id, name, scope } params, RequestOptionsoptions?): [ResourceGroupUpdateResponse](<https://developers.cloudflare.com/api/typescript/resources/iam#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)>) {id, scope, meta, name }

PUT/accounts/{account\_id}/iam/resource\_groups/{resource\_group\_id}

##### [Remove Resource Group](https://developers.cloudflare.com/api/typescript/resources/iam/subresources/resource_groups/methods/delete)

client.iam.resourceGroups.delete(stringresourceGroupID, ResourceGroupDeleteParams {account\_id } params, RequestOptionsoptions?): [ResourceGroupDeleteResponse](<https://developers.cloudflare.com/api/typescript/resources/iam#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_delete_response%20%3E%20(schema)>) {id } | null

DELETE/accounts/{account\_id}/iam/resource\_groups/{resource\_group\_id}

##### ModelsExpand Collapse

<details>

<summary>

ResourceGroupListResponse {id, scope, meta, name }

A group of scoped resources.

</summary>

id: string

Identifier of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

<details>

<summary>

scope: Scope {key, objects }

A scope is a combination of scope objects which provides additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20key">Link to this property</a>

<details>

<summary>

objects: Array&lt;Object&gt;

A list of scope objects for additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects%20%3E%20(items)%20%3E%20(property)%20key">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20scope">Link to this property</a>

<details>

<summary>

meta?: Meta {key, value }

Attributes associated to the resource group.

</summary>

key?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20key">Link to this property</a>

value?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20meta">Link to this property</a>

name?: string

Name of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

</details>

[Link to this property](<#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_list_response%20%3E%20(schema)>)

<details>

<summary>

ResourceGroupGetResponse {id, scope, meta, name }

A group of scoped resources.

</summary>

id: string

Identifier of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

<details>

<summary>

scope: Scope {key, objects }

A scope is a combination of scope objects which provides additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20key">Link to this property</a>

<details>

<summary>

objects: Array&lt;Object&gt;

A list of scope objects for additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects%20%3E%20(items)%20%3E%20(property)%20key">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20scope">Link to this property</a>

<details>

<summary>

meta?: Meta {key, value }

Attributes associated to the resource group.

</summary>

key?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20key">Link to this property</a>

value?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20meta">Link to this property</a>

name?: string

Name of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

</details>

[Link to this property](<#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_get_response%20%3E%20(schema)>)

<details>

<summary>

ResourceGroupCreateResponse {id, scope, meta, name }

A group of scoped resources.

</summary>

id: string

Identifier of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

<details>

<summary>

scope: Scope {key, objects }

A scope is a combination of scope objects which provides additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20key">Link to this property</a>

<details>

<summary>

objects: Array&lt;Object&gt;

A list of scope objects for additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects%20%3E%20(items)%20%3E%20(property)%20key">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20scope">Link to this property</a>

<details>

<summary>

meta?: Meta {key, value }

Attributes associated to the resource group.

</summary>

key?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20key">Link to this property</a>

value?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20meta">Link to this property</a>

name?: string

Name of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

</details>

[Link to this property](<#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_create_response%20%3E%20(schema)>)

<details>

<summary>

ResourceGroupUpdateResponse {id, scope, meta, name }

A group of scoped resources.

</summary>

id: string

Identifier of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

<details>

<summary>

scope: Scope {key, objects }

A scope is a combination of scope objects which provides additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Account ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20key">Link to this property</a>

<details>

<summary>

objects: Array&lt;Object&gt;

A list of scope objects for additional context.

</summary>

key: string

This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects%20%3E%20(items)%20%3E%20(property)%20key">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20scope%20%3E%20(property)%20objects">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20scope">Link to this property</a>

<details>

<summary>

meta?: Meta {key, value }

Attributes associated to the resource group.

</summary>

key?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20key">Link to this property</a>

value?: string

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20meta%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20meta">Link to this property</a>

name?: string

Name of the resource group.

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

</details>

[Link to this property](<#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_update_response%20%3E%20(schema)>)

<details>

<summary>

ResourceGroupDeleteResponse {id }

</summary>

id: string

Identifier

maxLength32

minLength32

<a href="#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_delete_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20iam.resource_groups%20%3E%20(model)%20resource_group_delete_response%20%3E%20(schema)>)