Cloudflare API | User › User Details

API Reference

Overview

Account & User Management

Abuse Reports

Certificate Management

ACM

Certificate Authorities

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

SSL

Cloudflare One

Email Security

Zero Trust

DNS

Account Custom Nameservers

DNS

DNS Firewall

Domain/Zone Management

IP Addresses

Media

Networking

Magic Cloud Networking

Magic Network Monitoring

Magic Transit

Network Interconnects

Observability

Radar

Routing & Performance

Rules

Security

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Workers & Pages

Workers For Platforms

Shared

User

user

Methods

User Details -> Envelope<{ id, betas, country, 11 more... }>

get/user

User Details

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)

User Details Write User Details Read

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: { id, betas, country, 11 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/user \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

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": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
    "betas": [
      "zone_level_access_beta"
    ],
    "country": "US",
    "first_name": "John",
    "has_business_zones": true,
    "has_enterprise_zones": true,
    "has_pro_zones": true,
    "last_name": "Appleseed",
    "organizations": [
      {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "Cloudflare, Inc.",
        "permissions": [
          "#zones:read"
        ],
        "roles": [
          "All Privileges - Super Administrator"
        ],
        "status": "member"
      }
    ],
    "suspended": true,
    "telephone": "+1 123-123-1234",
    "two_factor_authentication_enabled": true,
    "two_factor_authentication_locked": true,
    "zipcode": "12345"
  }
}

Edit User -> Envelope<{ id, betas, country, 11 more... }>

patch/user

Edit part of your user details.

User

Audit Logs

user.audit_logs

Methods

Get User Audit Logs -> V4PagePaginationArray<

AuditLog

get/user/audit_logs

Gets a list of audit logs for a user account. Can be filtered by who made the change, on which zone, and the timeframe of the change.

User

Billing

user.billing

User Billing

History

user.billing.history

Methods

Billing History Details -> V4PagePaginationArray<

BillingHistory

Deprecated

get/user/billing/history

Accesses your billing history object.

Domain types

BillingHistory = { id, action, amount, 5 more... }

User Billing

Profile

user.billing.profile

Methods

Billing Profile Details -> Envelope<{ id, account_type, address, 36 more... }>

Deprecated

get/user/billing/profile

Accesses your billing profile object.

User

Invites

user.invites

Methods

List Invitations -> SinglePage<

Invite

get/user/invites

Lists all invitations associated with my user.

Invitation Details -> Envelope<

Invite

get/user/invites/{invite_id}

Gets the details of an invitation.

Respond To Invitation -> Envelope<

Invite

patch/user/invites/{invite_id}

Responds to an invitation.

Domain types

Invite = { invited_member_id, organization_id, id, 8 more... }

User

Organizations

user.organizations

Methods

List Organizations -> V4PagePaginationArray<

Organization

Deprecated

get/user/organizations

Lists organizations the user is associated with.

Organization Details -> Envelope<unknown>

Deprecated

get/user/organizations/{organization_id}

Gets a specific organization the user is associated with.

Leave Organization -> { id }

Deprecated

delete/user/organizations/{organization_id}

Removes association to an organization.

Domain types

Organization = { id, name, permissions, 2 more... }

User

Subscriptions

user.subscriptions

Methods

Get User Subscriptions -> SinglePage<

Subscription

get/user/subscriptions

Lists all of a user's subscriptions.

Update User Subscription -> Envelope<unknown | string>

put/user/subscriptions/{identifier}

Updates a user's subscriptions.

Delete User Subscription -> { subscription_id }

delete/user/subscriptions/{identifier}

Deletes a user's subscription.

User

Tokens

user.tokens

Methods

List Tokens -> V4PagePaginationArray<

Token

get/user/tokens

List all access tokens you created.

Token Details -> Envelope<

Token

get/user/tokens/{token_id}

Get information about a specific token.

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

post/user/tokens

Create a new access token.

Update Token -> Envelope<

Token

put/user/tokens/{token_id}

Update an existing token.

Delete Token -> Envelope<{ id }>

delete/user/tokens/{token_id}

Destroy a token.

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

get/user/tokens/verify

Test whether a token works.

User Tokens

Permission Groups

user.tokens.permission_groups

Methods

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

get/user/tokens/permission_groups

Find all available permission groups for API Tokens

User Tokens

Value

user.tokens.value

Methods

Roll Token -> Envelope<

TokenValue

put/user/tokens/{token_id}/value

Roll the token secret.