Memberships
memberships
Methods
Delete Membership -> Envelope<{ id }>
delete/memberships/{membership_id}
Remove the associated member from an account.
Membership Details -> Envelope<{ id, account, api_access_enabled, 4 more... }>
get/memberships/{membership_id}
Get a specific membership.
get/memberships
List memberships of accounts the user can access.
Security
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example: X-Auth-Email: user@example.com
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example: X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Memberships Write Memberships Read
Parameters
account: {
Optional
name: string
(maxLength: 100)Optional
Account name
}
direction:
Optional
Direction to order memberships.
"asc"
"desc"
name: string
(maxLength: 100)Optional
Account name
order:
Optional
Field to order memberships by.
"id"
"account.name"
"status"
page: number
(minimum: 1)Optional
Page number of paginated results.
per_page: number
(maximum: 50, minimum: 5)Optional
Number of memberships per page.
status:
Optional
Status of this membership.
"accepted"
"pending"
"rejected"
Response fields
IAMCollectionMembershipResponse = { errors, messages, success, 2 more... }
IAMCollectionMembershipResponseWithPolicies = { errors, messages, success, 2 more... }
Request example
200Example
Update Membership -> Envelope<{ id, account, api_access_enabled, 4 more... }>
put/memberships/{membership_id}
Accept or reject this account invitation.
Domain types
Membership = { id, account, api_access_enabled, 3 more... }