[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/python/resources/iam/subresources/user_groups [Back]  [Original]
User Groups | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
Python
API Reference
IAM
Copy Markdown

User Groups

List User Groups
iam.user_groups.list(UserGroupListParams**kwargs) -> SyncV4PagePaginationArray[UserGroupListResponse]
GET/accounts/{account_id}/iam/user_groups
User Group Details
iam.user_groups.get(struser_group_id, UserGroupGetParams**kwargs) -> UserGroupGetResponse
GET/accounts/{account_id}/iam/user_groups/{user_group_id}
Create User Group
iam.user_groups.create(UserGroupCreateParams**kwargs) -> UserGroupCreateResponse
POST/accounts/{account_id}/iam/user_groups
Update User Group
iam.user_groups.update(struser_group_id, UserGroupUpdateParams**kwargs) -> UserGroupUpdateResponse
PUT/accounts/{account_id}/iam/user_groups/{user_group_id}
Remove User Group
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
created_on: datetime

Timestamp for the creation of the user group

formatdate-time
modified_on: datetime

Last time the user group was modified.

formatdate-time
name: str

Name of the user group.

policies: Optional[List[Policy]]

Policies attached to the User group

id: Optional[str]

Policy identifier.

access: Optional[Literal["allow", "deny"]]

Allow or deny operations against the resources.

One of the following:
"allow"
"deny"
permission_groups: Optional[List[PolicyPermissionGroup]]

A set of permission groups that are specified to the policy.

id: str

Identifier of the permission group.

meta: Optional[PolicyPermissionGroupMeta]

Attributes associated to the permission group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the permission group.

resource_groups: Optional[List[PolicyResourceGroup]]

A list of resource groups that the policy applies to.

id: str

Identifier of the resource group.

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.)

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.)

meta: Optional[PolicyResourceGroupMeta]

Attributes associated to the resource group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the resource group.

class UserGroupGetResponse:

A group of policies resources.

id: str

User Group identifier tag.

maxLength32
minLength32
created_on: datetime

Timestamp for the creation of the user group

formatdate-time
modified_on: datetime

Last time the user group was modified.

formatdate-time
name: str

Name of the user group.

policies: Optional[List[Policy]]

Policies attached to the User group

id: Optional[str]

Policy identifier.

access: Optional[Literal["allow", "deny"]]

Allow or deny operations against the resources.

One of the following:
"allow"
"deny"
permission_groups: Optional[List[PolicyPermissionGroup]]

A set of permission groups that are specified to the policy.

id: str

Identifier of the permission group.

meta: Optional[PolicyPermissionGroupMeta]

Attributes associated to the permission group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the permission group.

resource_groups: Optional[List[PolicyResourceGroup]]

A list of resource groups that the policy applies to.

id: str

Identifier of the resource group.

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.)

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.)

meta: Optional[PolicyResourceGroupMeta]

Attributes associated to the resource group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the resource group.

class UserGroupCreateResponse:

A group of policies resources.

id: str

User Group identifier tag.

maxLength32
minLength32
created_on: datetime

Timestamp for the creation of the user group

formatdate-time
modified_on: datetime

Last time the user group was modified.

formatdate-time
name: str

Name of the user group.

policies: Optional[List[Policy]]

Policies attached to the User group

id: Optional[str]

Policy identifier.

access: Optional[Literal["allow", "deny"]]

Allow or deny operations against the resources.

One of the following:
"allow"
"deny"
permission_groups: Optional[List[PolicyPermissionGroup]]

A set of permission groups that are specified to the policy.

id: str

Identifier of the permission group.

meta: Optional[PolicyPermissionGroupMeta]

Attributes associated to the permission group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the permission group.

resource_groups: Optional[List[PolicyResourceGroup]]

A list of resource groups that the policy applies to.

id: str

Identifier of the resource group.

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.)

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.)

meta: Optional[PolicyResourceGroupMeta]

Attributes associated to the resource group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the resource group.

class UserGroupUpdateResponse:

A group of policies resources.

id: str

User Group identifier tag.

maxLength32
minLength32
created_on: datetime

Timestamp for the creation of the user group

formatdate-time
modified_on: datetime

Last time the user group was modified.

formatdate-time
name: str

Name of the user group.

policies: Optional[List[Policy]]

Policies attached to the User group

id: Optional[str]

Policy identifier.

access: Optional[Literal["allow", "deny"]]

Allow or deny operations against the resources.

One of the following:
"allow"
"deny"
permission_groups: Optional[List[PolicyPermissionGroup]]

A set of permission groups that are specified to the policy.

id: str

Identifier of the permission group.

meta: Optional[PolicyPermissionGroupMeta]

Attributes associated to the permission group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the permission group.

resource_groups: Optional[List[PolicyResourceGroup]]

A list of resource groups that the policy applies to.

id: str

Identifier of the resource group.

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.)

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.)

meta: Optional[PolicyResourceGroupMeta]

Attributes associated to the resource group.

key: Optional[str]
value: Optional[str]
name: Optional[str]

Name of the resource group.

class UserGroupDeleteResponse:
id: str

Identifier

maxLength32
minLength32

User GroupsMembers

List User Group Members
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
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
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
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
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.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The members status in the account.

One of the following:
"accepted"
"pending"
class MemberGetResponse:

Detailed member information for a User Group member.

id: str

Account member identifier.

created_at: Optional[datetime]

When the member was added to the user group.

formatdate-time
email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The members status in the account.

One of the following:
"accepted"
"pending"
user: Optional[User]

Details of the user associated with this membership.

id: Optional[str]

User identifier tag.

email: Optional[str]

The contact email address of the user.

maxLength90
first_name: Optional[str]

Users first name.

last_name: Optional[str]

Users last name.

class MemberCreateResponse:

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The members status in the account.

One of the following:
"accepted"
"pending"
class MemberUpdateResponse:

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The members status in the account.

One of the following:
"accepted"
"pending"
class MemberDeleteResponse:

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90
status: Optional[Literal["accepted", "pending"]]

The members status in the account.

One of the following:
"accepted"
"pending"
Previous

Resource Groups
Next

Members

On this page

Web Proxy Viewer  |  New URL  |  Original Page