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

# Permission Groups

##### [List Account Permission Groups](https://developers.cloudflare.com/api/python/resources/iam/subresources/permission_groups/methods/list)

iam.permission\_groups.list(PermissionGroupListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[PermissionGroupListResponse](<https://developers.cloudflare.com/api/python/resources/iam#(resource)%20iam.permission_groups%20%3E%20(model)%20permission_group_list_response%20%3E%20(schema)>)]

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

##### [Permission Group Details](https://developers.cloudflare.com/api/python/resources/iam/subresources/permission_groups/methods/get)

iam.permission\_groups.get(strpermission\_group\_id, PermissionGroupGetParams\*\*kwargs) -> [PermissionGroupGetResponse](<https://developers.cloudflare.com/api/python/resources/iam#(resource)%20iam.permission_groups%20%3E%20(model)%20permission_group_get_response%20%3E%20(schema)>)

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

##### ModelsExpand Collapse

<details>

<summary>

class PermissionGroupListResponse: …

A named group of permissions that map to a group of operations against resources.

</summary>

id: str

Identifier of the permission group.

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

<details>

<summary>

meta: Optional\[Meta]

Attributes associated to the permission group.

</summary>

category: Optional\[str]

A category used to group permission groups.

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

deprecated: Optional\[str]

Indicates whether the permission group is deprecated.

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

description: Optional\[str]

Additional information about the permission group.

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

editable: Optional\[str]

Indicates whether the permission group can be edited.

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

eol\_at: Optional\[datetime]

The planned end-of-life date and time, when provided.

formatdate-time

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

label: Optional\[str]

A label identifying the permission group.

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

scopes: Optional\[str]

The scope associated with the permission group.

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

visibility: Optional\[str]

Indicates the permission group’s availability or visibility.

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

</details>

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

name: Optional\[str]

Name of the permission group.

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

</details>

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

<details>

<summary>

class PermissionGroupGetResponse: …

A named group of permissions that map to a group of operations against resources.

</summary>

id: str

Identifier of the permission group.

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

<details>

<summary>

meta: Optional\[Meta]

Attributes associated to the permission group.

</summary>

category: Optional\[str]

A category used to group permission groups.

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

deprecated: Optional\[str]

Indicates whether the permission group is deprecated.

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

description: Optional\[str]

Additional information about the permission group.

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

editable: Optional\[str]

Indicates whether the permission group can be edited.

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

eol\_at: Optional\[datetime]

The planned end-of-life date and time, when provided.

formatdate-time

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

label: Optional\[str]

A label identifying the permission group.

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

scopes: Optional\[str]

The scope associated with the permission group.

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

visibility: Optional\[str]

Indicates the permission group’s availability or visibility.

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

</details>

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

name: Optional\[str]

Name of the permission group.

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

</details>

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