Skip to content
Cloudflare API
Start here
API Reference

Memberships

List Memberships
memberships.list(MembershipListParams**kwargs) -> SyncV4PagePaginationArray[Membership]
GET/memberships
Membership Details
memberships.get(strmembership_id) -> MembershipGetResponse
GET/memberships/{membership_id}
Update Membership
memberships.update(strmembership_id, MembershipUpdateParams**kwargs) -> MembershipUpdateResponse
PUT/memberships/{membership_id}
Delete Membership
memberships.delete(strmembership_id) -> MembershipDeleteResponse
DELETE/memberships/{membership_id}
ModelsExpand Collapse
class Membership: …
id: Optional[str]

Membership identifier tag.

maxLength32
account: Optional[Account]
api_access_enabled: Optional[bool]

Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

permissions: Optional[Permissions]

All access permissions for the user at the account.

analytics: Optional[PermissionGrant]
billing: Optional[PermissionGrant]
cache_purge: Optional[PermissionGrant]
dns: Optional[PermissionGrant]
dns_records: Optional[PermissionGrant]
lb: Optional[PermissionGrant]
logs: Optional[PermissionGrant]
organization: Optional[PermissionGrant]
ssl: Optional[PermissionGrant]
waf: Optional[PermissionGrant]
zone_settings: Optional[PermissionGrant]
zones: Optional[PermissionGrant]
roles: Optional[List[str]]

List of role names the membership has for this account.

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

Status of this membership.

One of the following:
"accepted"
"pending"
"rejected"
class MembershipGetResponse: …
id: Optional[str]

Membership identifier tag.

maxLength32
account: Optional[Account]
api_access_enabled: Optional[bool]

Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

permissions: Optional[Permissions]

All access permissions for the user at the account.

analytics: Optional[PermissionGrant]
billing: Optional[PermissionGrant]
cache_purge: Optional[PermissionGrant]
dns: Optional[PermissionGrant]
dns_records: Optional[PermissionGrant]
lb: Optional[PermissionGrant]
logs: Optional[PermissionGrant]
organization: Optional[PermissionGrant]
ssl: Optional[PermissionGrant]
waf: Optional[PermissionGrant]
zone_settings: Optional[PermissionGrant]
zones: Optional[PermissionGrant]
policies: Optional[List[Policy]]

Access policy for the membership

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: List[PolicyResourceGroupScope]

The scope associated to the resource group

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.

roles: Optional[List[str]]

List of role names the membership has for this account.

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

Status of this membership.

One of the following:
"accepted"
"pending"
"rejected"
class MembershipUpdateResponse: …
id: Optional[str]

Membership identifier tag.

maxLength32
account: Optional[Account]
api_access_enabled: Optional[bool]

Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

permissions: Optional[Permissions]

All access permissions for the user at the account.

analytics: Optional[PermissionGrant]
billing: Optional[PermissionGrant]
cache_purge: Optional[PermissionGrant]
dns: Optional[PermissionGrant]
dns_records: Optional[PermissionGrant]
lb: Optional[PermissionGrant]
logs: Optional[PermissionGrant]
organization: Optional[PermissionGrant]
ssl: Optional[PermissionGrant]
waf: Optional[PermissionGrant]
zone_settings: Optional[PermissionGrant]
zones: Optional[PermissionGrant]
policies: Optional[List[Policy]]

Access policy for the membership

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: List[PolicyResourceGroupScope]

The scope associated to the resource group

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.

roles: Optional[List[str]]

List of role names the membership has for this account.

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

Status of this membership.

One of the following:
"accepted"
"pending"
"rejected"
class MembershipDeleteResponse: …
id: Optional[str]

Membership identifier tag.

maxLength32