---
title: Memberships
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Memberships

##### [List Memberships](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/list)

client.memberships.list(MembershipListParams { account, direction, name, 4 more } query?, RequestOptionsoptions?): V4PagePaginationArray<[Membership](https://developers.cloudflare.com/api/typescript/resources/memberships#%28resource%29%20memberships%20%3E%20%28model%29%20membership%20%3E%20%28schema%29) { id, account, api\_access\_enabled, 3 more } \>

GET/memberships

##### [Membership Details](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/get)

client.memberships.get(stringmembershipID, RequestOptionsoptions?): [MembershipGetResponse](https://developers.cloudflare.com/api/typescript/resources/memberships#%28resource%29%20memberships%20%3E%20%28model%29%20membership%5Fget%5Fresponse%20%3E%20%28schema%29) { id, account, api\_access\_enabled, 4 more } 

GET/memberships/{membership\_id}

##### [Update Membership](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/update)

client.memberships.update(stringmembershipID, MembershipUpdateParams { status } body, RequestOptionsoptions?): [MembershipUpdateResponse](https://developers.cloudflare.com/api/typescript/resources/memberships#%28resource%29%20memberships%20%3E%20%28model%29%20membership%5Fupdate%5Fresponse%20%3E%20%28schema%29) { id, account, api\_access\_enabled, 4 more } 

PUT/memberships/{membership\_id}

##### [Delete Membership](https://developers.cloudflare.com/api/typescript/resources/memberships/methods/delete)

client.memberships.delete(stringmembershipID, RequestOptionsoptions?): [MembershipDeleteResponse](https://developers.cloudflare.com/api/typescript/resources/memberships#%28resource%29%20memberships%20%3E%20%28model%29%20membership%5Fdelete%5Fresponse%20%3E%20%28schema%29) { id } 

DELETE/memberships/{membership\_id}

##### ModelsExpand Collapse 

Membership { id, account, api\_access\_enabled, 3 more } 

id?: string

Membership identifier tag.

maxLength32

account?: [Account](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts%20%3E%20%28model%29%20account%20%3E%20%28schema%29) { id, name, type, 3 more } 

api\_access\_enabled?: boolean | null

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

permissions?: Permissions { analytics, billing, cache\_purge, 9 more } 

All access permissions for the user at the account.

analytics?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

billing?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

cache\_purge?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

dns?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

dns\_records?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

lb?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

logs?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

organization?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

ssl?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

waf?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

zone\_settings?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

zones?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

roles?: Array<string\>

List of role names the membership has for this account.

status?: "accepted" | "pending" | "rejected"

Status of this membership.

One of the following:

"accepted"

"pending"

"rejected"

MembershipGetResponse { id, account, api\_access\_enabled, 4 more } 

id?: string

Membership identifier tag.

maxLength32

account?: [Account](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts%20%3E%20%28model%29%20account%20%3E%20%28schema%29) { id, name, type, 3 more } 

api\_access\_enabled?: boolean | null

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

permissions?: Permissions { analytics, billing, cache\_purge, 9 more } 

All access permissions for the user at the account.

analytics?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

billing?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

cache\_purge?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

dns?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

dns\_records?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

lb?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

logs?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

organization?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

ssl?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

waf?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

zone\_settings?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

zones?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

policies?: Array<Policy\>

Access policy for the membership

id?: string

Policy identifier.

access?: "allow" | "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission\_groups?: Array<PermissionGroup\>

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

id: string

Identifier of the permission group.

meta?: Meta { key, value } 

Attributes associated to the permission group.

key?: string

value?: string

name?: string

Name of the permission group.

resource\_groups?: Array<ResourceGroup\>

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

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

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

meta?: Meta { key, value } 

Attributes associated to the resource group.

key?: string

value?: string

name?: string

Name of the resource group.

roles?: Array<string\>

List of role names the membership has for this account.

status?: "accepted" | "pending" | "rejected"

Status of this membership.

One of the following:

"accepted"

"pending"

"rejected"

MembershipUpdateResponse { id, account, api\_access\_enabled, 4 more } 

id?: string

Membership identifier tag.

maxLength32

account?: [Account](https://developers.cloudflare.com/api/typescript/resources/accounts#%28resource%29%20accounts%20%3E%20%28model%29%20account%20%3E%20%28schema%29) { id, name, type, 3 more } 

api\_access\_enabled?: boolean | null

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

permissions?: Permissions { analytics, billing, cache\_purge, 9 more } 

All access permissions for the user at the account.

analytics?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

billing?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

cache\_purge?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

dns?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

dns\_records?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

lb?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

logs?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

organization?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

ssl?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

waf?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

zone\_settings?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

zones?: [PermissionGrant](https://developers.cloudflare.com/api/typescript/resources/$shared#%28resource%29%20%24shared%20%3E%20%28model%29%20permission%5Fgrant%20%3E%20%28schema%29) { read, write } 

policies?: Array<Policy\>

Access policy for the membership

id?: string

Policy identifier.

access?: "allow" | "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission\_groups?: Array<PermissionGroup\>

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

id: string

Identifier of the permission group.

meta?: Meta { key, value } 

Attributes associated to the permission group.

key?: string

value?: string

name?: string

Name of the permission group.

resource\_groups?: Array<ResourceGroup\>

A list of resource groups that the policy applies to.

id: string

Identifier of the resource group.

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

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

meta?: Meta { key, value } 

Attributes associated to the resource group.

key?: string

value?: string

name?: string

Name of the resource group.

roles?: Array<string\>

List of role names the membership has for this account.

status?: "accepted" | "pending" | "rejected"

Status of this membership.

One of the following:

"accepted"

"pending"

"rejected"

MembershipDeleteResponse { id } 

id?: string

Membership identifier tag.

maxLength32