User

ModelsExpand Collapse

UserGetResponse object { id, email, betas, 12 more }

id: string

Identifier of the user.

email: string

Current email address of the user.

formatemail

betas: optional array of string

Lists the betas that the user is participating in.

country: optional string

The country in which the user lives.

maxLength30

first_name: optional string

User’s first name

maxLength60

has_business_zones: optional boolean

Indicates whether user has any business zones

has_enterprise_zones: optional boolean

Indicates whether user has any enterprise zones

has_pro_zones: optional boolean

Indicates whether user has any pro zones

last_name: optional string

User’s last name

maxLength60

organizations: optional array of Organization { id, name, permissions, 2 more }

id: optional string

Identifier

maxLength32

minLength32

Organization name.

maxLength100

permissions: optional array of Permission

Access permissions for this User.

roles: optional array of string

List of roles that a user has within an organization.

status: optional Status

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

suspended: optional boolean

Indicates whether user has been suspended

telephone: optional string

User’s telephone number

maxLength20

two_factor_authentication_enabled: optional boolean

Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.

two_factor_authentication_locked: optional boolean

Indicates whether two-factor authentication is required by one of the accounts that the user is a member of.

zipcode: optional string

The zipcode or postal code where the user lives.

maxLength20

UserEditResponse object { id, email, betas, 12 more }

id: string

Identifier of the user.

email: string

Current email address of the user.

formatemail

betas: optional array of string

Lists the betas that the user is participating in.

country: optional string

The country in which the user lives.

maxLength30

first_name: optional string

User’s first name

maxLength60

has_business_zones: optional boolean

Indicates whether user has any business zones

has_enterprise_zones: optional boolean

Indicates whether user has any enterprise zones

has_pro_zones: optional boolean

Indicates whether user has any pro zones

last_name: optional string

User’s last name

maxLength60

organizations: optional array of Organization { id, name, permissions, 2 more }

id: optional string

Identifier

maxLength32

minLength32

Organization name.

maxLength100

permissions: optional array of Permission

Access permissions for this User.

roles: optional array of string

List of roles that a user has within an organization.

status: optional Status

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

suspended: optional boolean

Indicates whether user has been suspended

telephone: optional string

User’s telephone number

maxLength20

two_factor_authentication_enabled: optional boolean

Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.

two_factor_authentication_locked: optional boolean

Indicates whether two-factor authentication is required by one of the accounts that the user is a member of.

zipcode: optional string

The zipcode or postal code where the user lives.

maxLength20

UserAudit Logs

UserBilling

UserBillingHistory

ModelsExpand Collapse

BillingHistory object { id, action, amount, 5 more }

id: string

Billing item identifier tag.

maxLength32

action: string

The billing item action.

maxLength30

amount: number

The amount associated with this billing item.

currency: string

The monetary unit in which pricing information is displayed.

description: string

The billing item description.

maxLength255

occurred_at: string

When the billing item was created.

formatdate-time

type: string

The billing item type.

maxLength30

zone: object { name }

UserBillingProfile

ModelsExpand Collapse

ProfileGetResponse object { id, account_type, address, 35 more }

id: optional string

Billing item identifier tag.

maxLength32

account_type: optional string

address: optional string

address2: optional string

balance: optional string

card_expiry_month: optional number

card_expiry_year: optional number

card_number: optional string

city: optional string

company: optional string

country: optional string

created_on: optional string

formatdate-time

device_data: optional string

edited_on: optional string

formatdate-time

enterprise_billing_email: optional string

enterprise_primary_email: optional string

first_name: optional string

is_partner: optional boolean

last_name: optional string

next_bill_date: optional string

formatdate-time

payment_address: optional string

payment_address2: optional string

payment_city: optional string

payment_country: optional string

payment_email: optional string

payment_first_name: optional string

payment_gateway: optional string

payment_last_name: optional string

payment_nonce: optional string

payment_state: optional string

payment_zipcode: optional string

primary_email: optional string

state: optional string

tax_id_type: optional string

telephone: optional string

validation_code: optional string

vat: optional string

zipcode: optional string

UserInvites

ModelsExpand Collapse

Invite object { invited_member_id, organization_id, id, 8 more }

invited_member_id: string

ID of the user to add to the organization.

maxLength32

organization_id: string

ID of the organization the user will be added to.

maxLength32

id: optional string

Invite identifier tag.

maxLength32

expires_on: optional string

When the invite is no longer active.

formatdate-time

invited_by: optional string

The email address of the user who created the invite.

maxLength90

invited_member_email: optional string

Email address of the user to add to the organization.

maxLength90

invited_on: optional string

When the invite was sent.

formatdate-time

organization_is_enforcing_twofactor: optional boolean

organization_name: optional string

Organization name.

maxLength100

roles: optional array of string

List of role names the membership has for this account.

status: optional "pending" or "accepted" or "rejected" or "expired"

Current status of the invitation.

One of the following:

"pending"

"accepted"

"rejected"

"expired"

UserOrganizations

Organization Details

Deprecated

GET/user/organizations/{organization_id}

Leave Organization

Deprecated

DELETE/user/organizations/{organization_id}

ModelsExpand Collapse

Organization object { id, name, permissions, 2 more }

id: optional string

Identifier

maxLength32

minLength32

Organization name.

maxLength100

permissions: optional array of Permission

Access permissions for this User.

roles: optional array of string

List of roles that a user has within an organization.

status: optional Status

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

OrganizationGetResponse = unknown

OrganizationDeleteResponse object { id }

id: optional string

Identifier

maxLength32

minLength32

UserSpectrum Analytics

UserSpectrum AnalyticsZones

UserSpectrum AnalyticsZonesReports

Get zones bandwidth report

GET/user/spectrum_analytics/zones/report

ModelsExpand Collapse

ReportGetResponse = array of object { totals, zone_id }

totals: object { bandwidth }

bandwidth: object { all, egress, ingress }

all: number

Sum of ingress and egress bytes transferred.

egress: number

Sum of egress bytes transferred.

ingress: number

Sum of ingress bytes transferred.

zone_id: string

Identifier.

maxLength32

UserSubscriptions

ModelsExpand Collapse

SubscriptionUpdateResponse = unknown or string

One of the following:

unknown

string

SubscriptionDeleteResponse object { subscription_id }

subscription_id: optional string

Subscription identifier tag.

maxLength32

UserTenants

ModelsExpand Collapse

TenantListResponse object { cdate, customer_id, edate, 10 more }

cdate: string

formatdate-time

customer_id: string

edate: string

formatdate-time

tenant_contacts: object { email, website }

email: optional string

website: optional string

tenant_labels: array of string

tenant_metadata: object { billing_account_type, configuration_account, created_by, 4 more }

billing_account_type: optional string

configuration_account: optional string

created_by: optional string

dns: optional object { ns_pool }

ns_pool: object { primary, secondary }

primary: string

secondary: string

flags: optional map[string]

innate_account_entitlements: optional array of object { allocation, feature }

allocation: object { type, value }

type: string

value: boolean or number or string or 2 more

One of the following:

boolean

number

string

map[unknown]

array of unknown

feature: object { key }

key: string

tenant_entitlements: optional array of object { allocation, feature }

allocation: object { type, value }

type: string

value: boolean or number or string or 2 more

One of the following:

boolean

number

string

map[unknown]

array of unknown

feature: object { key }

key: string

tenant_name: string

tenant_network: object { choices }

choices: optional map[unknown]

tenant_status: string

tenant_tag: string

tenant_type: string

tenant_units: array of object { unit_memberships, unit_metadata, unit_name, 2 more }

unit_memberships: array of object { member_metadata, member_status, member_tag }

member_metadata: unknown

member_status: string

member_tag: string

unit_metadata: unknown

unit_name: string

unit_status: string

unit_tag: string

ui_flags: object { show_orgs_ui, show_tenants_ui }

Which top-level dashboard experiences to render for this tenant; both may be true.

show_orgs_ui: boolean

Render the Organizations experience for this tenant.

show_tenants_ui: boolean

Render the legacy Tenants experience for this tenant.

UserTokens

ModelsExpand Collapse

TokenCreateResponse object { id, condition, creator_email_at_creation, 13 more }

id: optional string

Token identifier tag.

maxLength32

condition: optional object { request_ip }

request_ip: optional object { in, not_in }

Client IP restrictions.

in: optional array of TokenConditionCIDRList

List of IPv4/IPv6 CIDR addresses.

not_in: optional array of TokenConditionCIDRList

List of IPv4/IPv6 CIDR addresses.

creator_email_at_creation: optional string

The email address of the user who created the token at the time of creation. Only present for Account Owned API Tokens when a creator email was available.

maxLength90

expires_on: optional string

The expiration time on or after which the JWT MUST NOT be accepted for processing.

formatdate-time

issued_on: optional string

The time on which the token was created.

formatdate-time

last_used_on: optional string

Last time the token was used.

formatdate-time

modified_on: optional string

Last time the token was modified.

formatdate-time

Token name.

maxLength120

not_before: optional string

The time before which the token MUST NOT be accepted for processing.

formatdate-time

policies: optional array of TokenPolicy { id, effect, permission_groups, resources }

List of access policies assigned to the token.

id: string

Policy identifier.

effect: "allow" or "deny"

Allow or deny operations against the resources.

One of the following:

"allow"

"deny"

permission_groups: array of object { id, meta, name }

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

id: string

Identifier of the permission group.

meta: optional object { category, deprecated, description, 5 more }

Attributes associated to the permission group.

category: optional string

A category used to group permission groups.

deprecated: optional string

Indicates whether the permission group is deprecated.

description: optional string

Additional information about the permission group.

editable: optional string

Indicates whether the permission group can be edited.

eol_at: optional string

The planned end-of-life date and time, when provided.

formatdate-time

label: optional string

A label identifying the permission group.

scopes: optional string

The scope associated with the permission group.

visibility: optional string

Indicates the permission group’s availability or visibility.

Name of the permission group.

resources: map[string] or map[map[string]]

A list of resource names that the policy applies to.

One of the following:

IAMResourcesTypeObjectString = map[string]

Map of simple string resource permissions

IAMResourcesTypeObjectNested = map[map[string]]

Map of nested resource permissions

provisioner_id: optional string

The identifier of the service that provisioned the token. For an OAuth-provisioned token, this is the OAuth client identifier. Present when provisioner_type is present and null when the identifier is unavailable.

provisioner_type: optional string

The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens.

status: optional "active" or "disabled" or "expired"

Status of the token.

One of the following:

"active"

"disabled"

"expired"

token_prefix: optional string

The prefix of the token value, before the first underscore. Use it with token_suffix to identify a token. Only present for tokens created or rolled after this field was added.

token_suffix: optional string

The last 4 characters of the token value. Use it with token_prefix to identify a token. It is not unique. Only present for tokens created or rolled after this field was added.

maxLength4

minLength4

value: optional TokenValue

The token value.

maxLength80

minLength40

TokenDeleteResponse object { id }

id: string

Identifier

maxLength32

minLength32

TokenVerifyResponse object { id, status, expires_on, not_before }

id: string

Token identifier tag.

maxLength32

status: "active" or "disabled" or "expired"

Status of the token.

One of the following:

"active"

"disabled"

"expired"

expires_on: optional string

The expiration time on or after which the JWT MUST NOT be accepted for processing.

formatdate-time

not_before: optional string

The time before which the token MUST NOT be accepted for processing.

formatdate-time

UserTokensPermission Groups

List Token Permission Groups

GET/user/tokens/permission_groups

ModelsExpand Collapse

PermissionGroupListResponse object { id, category, is_selectable, 2 more }

id: optional string

Public ID.

category: optional "developer_platform" or "ai_and_machine_learning" or "dns_and_zones" or 10 more

Product category that this permission group belongs to.

One of the following:

"developer_platform"

"ai_and_machine_learning"

"dns_and_zones"

"app_security"

"rules_and_configuration"

"cloudflare_one_and_zero_trust"

"analytics_and_logs"

"network_services"

"media"

"email_and_messaging"

"cache_and_performance"

"account_and_billing"

"other"

is_selectable: optional boolean

Whether the caller can select this permission group when creating a token.

Permission Group Name

scopes: optional array of "com.cloudflare.api.account" or "com.cloudflare.api.account.zone" or "com.cloudflare.api.user" or "com.cloudflare.edge.r2.bucket"

Resources to which the Permission Group is scoped

One of the following:

"com.cloudflare.api.account"

"com.cloudflare.api.account.zone"

"com.cloudflare.api.user"

"com.cloudflare.edge.r2.bucket"

UserTokensValue

Roll Token

PUT/user/tokens/{token_id}/value