API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Memberships

List Memberships

client.memberships.list(MembershipListParams { account, direction, name, 4 more } query?, RequestOptionsoptions?): V4PagePaginationArray<Membership { id, account, api_access_enabled, 3 more } >

GET/memberships

Membership Details

client.memberships.get(stringmembershipId, RequestOptionsoptions?): MembershipGetResponse { id, account, api_access_enabled, 4 more }

GET/memberships/{membership_id}

Update Membership

client.memberships.update(stringmembershipId, MembershipUpdateParams { status } body, RequestOptionsoptions?): MembershipUpdateResponse { id, account, api_access_enabled, 4 more }

PUT/memberships/{membership_id}

Delete Membership

client.memberships.delete(stringmembershipId, RequestOptionsoptions?): MembershipDeleteResponse { id }

DELETE/memberships/{membership_id}

ModelsExpand Collapse

Membership { id, account, api_access_enabled, 3 more }

id?: string

Membership identifier tag.

maxLength32

account?: Account { 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 { read, write }

billing?: PermissionGrant { read, write }

cache_purge?: PermissionGrant { read, write }

dns?: PermissionGrant { read, write }

dns_records?: PermissionGrant { read, write }

lb?: PermissionGrant { read, write }

logs?: PermissionGrant { read, write }

organization?: PermissionGrant { read, write }

ssl?: PermissionGrant { read, write }

waf?: PermissionGrant { read, write }

zone_settings?: PermissionGrant { read, write }

zones?: PermissionGrant { 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 { 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 { read, write }

billing?: PermissionGrant { read, write }

cache_purge?: PermissionGrant { read, write }

dns?: PermissionGrant { read, write }

dns_records?: PermissionGrant { read, write }

lb?: PermissionGrant { read, write }

logs?: PermissionGrant { read, write }

organization?: PermissionGrant { read, write }

ssl?: PermissionGrant { read, write }

waf?: PermissionGrant { read, write }

zone_settings?: PermissionGrant { read, write }

zones?: PermissionGrant { 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: Array<Scope>

The scope associated to the resource group

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 { 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 { read, write }

billing?: PermissionGrant { read, write }

cache_purge?: PermissionGrant { read, write }

dns?: PermissionGrant { read, write }

dns_records?: PermissionGrant { read, write }

lb?: PermissionGrant { read, write }

logs?: PermissionGrant { read, write }

organization?: PermissionGrant { read, write }

ssl?: PermissionGrant { read, write }

waf?: PermissionGrant { read, write }

zone_settings?: PermissionGrant { read, write }

zones?: PermissionGrant { 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: Array<Scope>

The scope associated to the resource group

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