Cloudflare API | Accounts › Members

Delete a specific account (only available for tenant admins at this time). This is a permanent operation that will delete any zones or other resources under the account

Domain types

Account = { id, name, type, 3 more... }

Accounts

Account Organizations

accounts.account_organizations

Methods

Move Account -> Envelope<{ account_id, destination_organization_id, source_organization_id }>

post/accounts/{account_id}/move

Move an account within an organization hierarchy or an account outside an organization.

Accounts

Account Profile

accounts.account_profile

Methods

Get Account Profile -> Envelope<

AccountProfile

get/accounts/{account_id}/profile

Get account profile

Modify Account Profile ->

put/accounts/{account_id}/profile

Modify account profile

Domain types

AccountProfile = { business_address, business_email, business_name, 2 more... }

Accounts

Logs

accounts.logs

Accounts Logs

Audit

accounts.logs.audit

Methods

Get Account Audit Logs Version 2 Beta Release -> CursorPaginationAfter<{ id, account, action, 4 more... }>

get/accounts/{account_id}/logs/audit

Gets a list of audit logs for an account.

This is the beta release of Audit Logs Version 2. Since this is a beta version, there may be gaps or missing entries in the available audit logs. Be aware of the following limitations.

Audit logs are available only for the past 30 days.
Error handling is not yet implemented.

Accounts

Members

accounts.members

Methods

List Members -> V4PagePaginationArray<

Member

get/accounts/{account_id}/members

List all members of an account.

Member Details -> Envelope<

Member

get/accounts/{account_id}/members/{member_id}

Get information about a specific member of an account.

Add Member -> Envelope<

Member

post/accounts/{account_id}/members

Add a user to the list of members for this account.

Update Member -> Envelope<

Member

put/accounts/{account_id}/members/{member_id}

Modify an account member.

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)

SCIM Provisioning Account Settings Write

path Parameters

account_id: string

(maxLength: 32, minLength: 32)

Account identifier tag.

member_id: string

(maxLength: 32)

Membership identifier tag.

Response fields

errors: Array<{ code, message, documentation_url, 1 more... }>

messages: Array<{ code, message, documentation_url, 1 more... }>

success: true

Whether the API call was successful.

result:

Member

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/members/$MEMBER_ID \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{}'

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "4536bcfad5faccb111b47003c79917fa",
    "email": "user@example.com",
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "access": "allow",
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Magic Network Monitoring"
          }
        ],
        "resource_groups": [
          {
            "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
            "scope": [
              {
                "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
                "objects": [
                  {
                    "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                  }
                ]
              }
            ],
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
          }
        ]
      }
    ],
    "roles": [
      {
        "id": "3536bcfad5faccb999b47003c79917fb",
        "description": "Administrative access to the entire Account",
        "name": "Account Administrator",
        "permissions": {
          "analytics": {
            "read": true,
            "write": false
          },
          "billing": {
            "read": true,
            "write": false
          },
          "cache_purge": {
            "read": true,
            "write": false
          },
          "dns": {
            "read": true,
            "write": false
          },
          "dns_records": {
            "read": true,
            "write": false
          },
          "lb": {
            "read": true,
            "write": false
          },
          "logs": {
            "read": true,
            "write": false
          },
          "organization": {
            "read": true,
            "write": false
          },
          "ssl": {
            "read": true,
            "write": false
          },
          "waf": {
            "read": true,
            "write": false
          },
          "zone_settings": {
            "read": true,
            "write": false
          },
          "zones": {
            "read": true,
            "write": true
          }
        }
      }
    ],
    "status": "accepted",
    "user": {
      "email": "user@example.com",
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "first_name": "John",
      "last_name": "Appleseed",
      "two_factor_authentication_enabled": true
    }
  }
}

Remove Member -> Envelope<{ id }>

delete/accounts/{account_id}/members/{member_id}

Remove a member from an account.

Domain types

Status = "member" | "invited"

Whether the user is a member of the organization or has an invitation pending.

Accounts

Roles

accounts.roles

Methods

List Roles -> V4PagePaginationArray<

Role

get/accounts/{account_id}/roles

Get all available roles for an account.

Role Details -> Envelope<

Role

get/accounts/{account_id}/roles/{role_id}

Get information about a specific role for an account.

Accounts

Subscriptions

accounts.subscriptions

Methods

List Subscriptions -> SinglePage<

Subscription

get/accounts/{account_id}/subscriptions

Lists all of an account's subscriptions.

Create Subscription -> Envelope<

Subscription

post/accounts/{account_id}/subscriptions

Creates an account subscription.

Update Subscription -> Envelope<

Subscription

put/accounts/{account_id}/subscriptions/{subscription_identifier}

Updates an account subscription.

Delete Subscription -> Envelope<{ subscription_id }>

delete/accounts/{account_id}/subscriptions/{subscription_identifier}

Deletes an account's subscription.

Accounts

Tokens

accounts.tokens

Methods

List Tokens -> V4PagePaginationArray<

Token

get/accounts/{account_id}/tokens

List all Account Owned API tokens created for this account.

Token Details -> Envelope<

Token

get/accounts/{account_id}/tokens/{token_id}

Get information about a specific Account Owned API token.

Create Token -> Envelope<{ id, condition, expires_on, 8 more... }>

post/accounts/{account_id}/tokens

Create a new Account Owned API token.

Update Token -> Envelope<

Token

put/accounts/{account_id}/tokens/{token_id}

Update an existing token.

Delete Token -> Envelope<{ id }>

delete/accounts/{account_id}/tokens/{token_id}

Destroy an Account Owned API token.

Verify Token -> Envelope<{ id, status, expires_on, 1 more... }>

get/accounts/{account_id}/tokens/verify

Test whether a token works.

Accounts Tokens

Permission Groups

accounts.tokens.permission_groups

Methods

List Permission Groups -> SinglePage<{ id, name, scopes }>

get/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

List Permission Groups -> Envelope<Array<{ id, name, scopes }>>

get/accounts/{account_id}/tokens/permission_groups

Find all available permission groups for Account Owned API Tokens

Accounts Tokens

Value

accounts.tokens.value

Methods

Roll Token -> Envelope<

TokenValue

put/accounts/{account_id}/tokens/{token_id}/value

Roll the Account Owned API token secret.