--- title: User --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # User ##### [User Details](https://developers.cloudflare.com/api/resources/user/methods/get) GET/user ##### [Edit User](https://developers.cloudflare.com/api/resources/user/methods/edit) PATCH/user ##### ModelsExpand Collapse

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

id: string Identifier of the user. Link to this property email: string Current email address of the user. formatemail Link to this property betas: optional array of string Lists the betas that the user is participating in. Link to this property country: optional string The country in which the user lives. maxLength30 Link to this property first\_name: optional string User’s first name maxLength60 Link to this property has\_business\_zones: optional boolean Indicates whether user has any business zones Link to this property has\_enterprise\_zones: optional boolean Indicates whether user has any enterprise zones Link to this property has\_pro\_zones: optional boolean Indicates whether user has any pro zones Link to this property last\_name: optional string User’s last name maxLength60 Link to this property

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

id: optional string Identifier maxLength32 minLength32 Link to this property name: optional string Organization name. maxLength100 Link to this property permissions: optional array of Permission Access permissions for this User. Link to this property roles: optional array of string List of roles that a user has within an organization. Link to this property status: optional Status Whether the user is a member of the organization or has an invitation pending. Link to this property

Link to this property suspended: optional boolean Indicates whether user has been suspended Link to this property telephone: optional string User’s telephone number maxLength20 Link to this property two\_factor\_authentication\_enabled: optional boolean Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication. Link to this property 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. Link to this property zipcode: optional string The zipcode or postal code where the user lives. maxLength20 Link to this property

[Link to this property](<#(resource)%20user%20%3E%20(model)%20user_get_response%20%3E%20(schema)>)

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

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

[Link to this property](<#(resource)%20user%20%3E%20(model)%20user_edit_response%20%3E%20(schema)>) #### UserAudit Logs ##### [Get user audit logs](https://developers.cloudflare.com/api/resources/user/subresources/audit_logs/methods/list) GET/user/audit\_logs #### UserBilling #### UserBillingHistory ##### [Billing History Details](https://developers.cloudflare.com/api/resources/user/subresources/billing/subresources/history/methods/list) Deprecated GET/user/billing/history ##### ModelsExpand Collapse

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

id: string Billing item identifier tag. maxLength32 Link to this property action: string The billing item action. maxLength30 Link to this property amount: number The amount associated with this billing item. Link to this property currency: string The monetary unit in which pricing information is displayed. Link to this property description: string The billing item description. maxLength255 Link to this property occurred\_at: string When the billing item was created. formatdate-time Link to this property type: string The billing item type. maxLength30 Link to this property

zone: object {name }

name: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20user.billing.history%20%3E%20(model)%20billing_history%20%3E%20(schema)>) #### UserBillingProfile ##### [Billing Profile Details](https://developers.cloudflare.com/api/resources/user/subresources/billing/subresources/profile/methods/get) Deprecated GET/user/billing/profile ##### ModelsExpand Collapse

ProfileGetResponse object {id, account\_type, address, 35 more }

id: optional string Billing item identifier tag. maxLength32 Link to this property account\_type: optional string Link to this property address: optional string Link to this property address2: optional string Link to this property balance: optional string Link to this property card\_expiry\_month: optional number Link to this property card\_expiry\_year: optional number Link to this property card\_number: optional string Link to this property city: optional string Link to this property company: optional string Link to this property country: optional string Link to this property created\_on: optional string formatdate-time Link to this property device\_data: optional string Link to this property edited\_on: optional string formatdate-time Link to this property enterprise\_billing\_email: optional string Link to this property enterprise\_primary\_email: optional string Link to this property first\_name: optional string Link to this property is\_partner: optional boolean Link to this property last\_name: optional string Link to this property next\_bill\_date: optional string formatdate-time Link to this property payment\_address: optional string Link to this property payment\_address2: optional string Link to this property payment\_city: optional string Link to this property payment\_country: optional string Link to this property payment\_email: optional string Link to this property payment\_first\_name: optional string Link to this property payment\_gateway: optional string Link to this property payment\_last\_name: optional string Link to this property payment\_nonce: optional string Link to this property payment\_state: optional string Link to this property payment\_zipcode: optional string Link to this property primary\_email: optional string Link to this property state: optional string Link to this property tax\_id\_type: optional string Link to this property telephone: optional string Link to this property validation\_code: optional string Link to this property vat: optional string Link to this property zipcode: optional string Link to this property

[Link to this property](<#(resource)%20user.billing.profile%20%3E%20(model)%20profile_get_response%20%3E%20(schema)>) #### UserInvites ##### [List Invitations](https://developers.cloudflare.com/api/resources/user/subresources/invites/methods/list) GET/user/invites ##### [Invitation Details](https://developers.cloudflare.com/api/resources/user/subresources/invites/methods/get) GET/user/invites/{invite\_id} ##### [Respond to Invitation](https://developers.cloudflare.com/api/resources/user/subresources/invites/methods/edit) PATCH/user/invites/{invite\_id} ##### 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 Link to this property organization\_id: string ID of the organization the user will be added to. maxLength32 Link to this property id: optional string Invite identifier tag. maxLength32 Link to this property expires\_on: optional string When the invite is no longer active. formatdate-time Link to this property invited\_by: optional string The email address of the user who created the invite. maxLength90 Link to this property invited\_member\_email: optional string Email address of the user to add to the organization. maxLength90 Link to this property invited\_on: optional string When the invite was sent. formatdate-time Link to this property organization\_is\_enforcing\_twofactor: optional boolean Link to this property organization\_name: optional string Organization name. maxLength100 Link to this property roles: optional array of string List of role names the membership has for this account. Link to this property

status: optional "pending"or "accepted"or "rejected"or "expired" Current status of the invitation.

One of the following: "pending" Link to this property "accepted" Link to this property "rejected" Link to this property "expired" Link to this property

Link to this property

[Link to this property](<#(resource)%20user.invites%20%3E%20(model)%20invite%20%3E%20(schema)>) #### UserOrganizations ##### [List Organizations](https://developers.cloudflare.com/api/resources/user/subresources/organizations/methods/list) Deprecated GET/user/organizations ##### [Organization Details](https://developers.cloudflare.com/api/resources/user/subresources/organizations/methods/get) Deprecated GET/user/organizations/{organization\_id} ##### [Leave Organization](https://developers.cloudflare.com/api/resources/user/subresources/organizations/methods/delete) Deprecated DELETE/user/organizations/{organization\_id} ##### ModelsExpand Collapse

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

[Link to this property](<#(resource)%20user.organizations%20%3E%20(model)%20organization%20%3E%20(schema)>) OrganizationGetResponse = unknown [Link to this property](<#(resource)%20user.organizations%20%3E%20(model)%20organization_get_response%20%3E%20(schema)>)

OrganizationDeleteResponse object {id }

id: optional string Identifier maxLength32 minLength32 Link to this property

[Link to this property](<#(resource)%20user.organizations%20%3E%20(model)%20organization_delete_response%20%3E%20(schema)>) #### UserSpectrum Analytics #### UserSpectrum AnalyticsZones #### UserSpectrum AnalyticsZonesReports ##### [Get zones bandwidth report](https://developers.cloudflare.com/api/resources/user/subresources/spectrum_analytics/subresources/zones/subresources/reports/methods/get) 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. Link to this property egress: number Sum of egress bytes transferred. Link to this property ingress: number Sum of ingress bytes transferred. Link to this property

Link to this property

Link to this property zone\_id: string Identifier. maxLength32 Link to this property

[Link to this property](<#(resource)%20user.spectrum_analytics.zones.reports%20%3E%20(model)%20report_get_response%20%3E%20(schema)>) #### UserSubscriptions ##### [Get User Subscriptions](https://developers.cloudflare.com/api/resources/user/subresources/subscriptions/methods/get) GET/user/subscriptions ##### [Update User Subscription](https://developers.cloudflare.com/api/resources/user/subresources/subscriptions/methods/update) PUT/user/subscriptions/{identifier} ##### [Delete User Subscription](https://developers.cloudflare.com/api/resources/user/subresources/subscriptions/methods/delete) DELETE/user/subscriptions/{identifier} ##### ModelsExpand Collapse

SubscriptionUpdateResponse = unknownor string

One of the following: unknown Link to this property string Link to this property

[Link to this property](<#(resource)%20user.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)>)

SubscriptionDeleteResponse object {subscription\_id }

subscription\_id: optional string Subscription identifier tag. maxLength32 Link to this property

[Link to this property](<#(resource)%20user.subscriptions%20%3E%20(model)%20subscription_delete_response%20%3E%20(schema)>) #### UserTenants ##### [List user tenants](https://developers.cloudflare.com/api/resources/user/subresources/tenants/methods/list) GET/user/tenants #### UserTokens ##### [List Tokens](https://developers.cloudflare.com/api/resources/user/subresources/tokens/methods/list) GET/user/tokens ##### [Token Details](https://developers.cloudflare.com/api/resources/user/subresources/tokens/methods/get) GET/user/tokens/{token\_id} ##### [Create Token](https://developers.cloudflare.com/api/resources/user/subresources/tokens/methods/create) POST/user/tokens ##### [Update Token](https://developers.cloudflare.com/api/resources/user/subresources/tokens/methods/update) PUT/user/tokens/{token\_id} ##### [Delete Token](https://developers.cloudflare.com/api/resources/user/subresources/tokens/methods/delete) DELETE/user/tokens/{token\_id} ##### [Verify Token](https://developers.cloudflare.com/api/resources/user/subresources/tokens/methods/verify) GET/user/tokens/verify ##### ModelsExpand Collapse

TokenCreateResponse object {id, condition, creator\_email\_at\_creation, 11 more }

id: optional string Token identifier tag. maxLength32 Link to this property

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. Link to this property not\_in: optional array of TokenConditionCIDRList List of IPv4/IPv6 CIDR addresses. Link to this property

Link to this property

Link to this property 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 Link to this property expires\_on: optional string The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property issued\_on: optional string The time on which the token was created. formatdate-time Link to this property last\_used\_on: optional string Last time the token was used. formatdate-time Link to this property modified\_on: optional string Last time the token was modified. formatdate-time Link to this property name: optional string Token name. maxLength120 Link to this property not\_before: optional string The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property

policies: optional array of TokenPolicy { id, effect, permission\_groups, resources } List of access policies assigned to the token.

id: string Policy identifier. Link to this property

effect: "allow"or "deny" Allow or deny operations against the resources.

One of the following: "allow" Link to this property "deny" Link to this property

Link to this property

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. Link to this property

meta: optional object {category, deprecated, description, 5 more } Attributes associated to the permission group.

category: optional string A category used to group permission groups. Link to this property deprecated: optional string Indicates whether the permission group is deprecated. Link to this property description: optional string Additional information about the permission group. Link to this property editable: optional string Indicates whether the permission group can be edited. Link to this property eol\_at: optional string The planned end-of-life date and time, when provided. formatdate-time Link to this property label: optional string A label identifying the permission group. Link to this property scopes: optional string The scope associated with the permission group. Link to this property visibility: optional string Indicates the permission group’s availability or visibility. Link to this property

Link to this property name: optional string Name of the permission group. Link to this property

Link to this property

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 Link to this property IAMResourcesTypeObjectNested = map\[map\[string]] Map of nested resource permissions Link to this property

Link to this property

Link to this property 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. Link to this property provisioner\_type: optional string The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property

status: optional "active"or "disabled"or "expired" Status of the token.

One of the following: "active" Link to this property "disabled" Link to this property "expired" Link to this property

Link to this property value: optional TokenValue The token value. maxLength80 minLength40 Link to this property

[Link to this property](<#(resource)%20user.tokens%20%3E%20(model)%20token_create_response%20%3E%20(schema)>)

TokenDeleteResponse object {id }

id: string Identifier maxLength32 minLength32 Link to this property

[Link to this property](<#(resource)%20user.tokens%20%3E%20(model)%20token_delete_response%20%3E%20(schema)>)

TokenVerifyResponse object {id, status, expires\_on, not\_before }

id: string Token identifier tag. maxLength32 Link to this property

status: "active"or "disabled"or "expired" Status of the token.

One of the following: "active" Link to this property "disabled" Link to this property "expired" Link to this property

Link to this property expires\_on: optional string The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property not\_before: optional string The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property

[Link to this property](<#(resource)%20user.tokens%20%3E%20(model)%20token_verify_response%20%3E%20(schema)>) #### UserTokensPermission Groups ##### [List Token Permission Groups](https://developers.cloudflare.com/api/resources/user/subresources/tokens/subresources/permission_groups/methods/list) GET/user/tokens/permission\_groups ##### ModelsExpand Collapse

PermissionGroupListResponse object {id, category, is\_selectable, 2 more }

id: optional string Public ID. Link to this property

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" Link to this property "ai\_and\_machine\_learning" Link to this property "dns\_and\_zones" Link to this property "app\_security" Link to this property "rules\_and\_configuration" Link to this property "cloudflare\_one\_and\_zero\_trust" Link to this property "analytics\_and\_logs" Link to this property "network\_services" Link to this property "media" Link to this property "email\_and\_messaging" Link to this property "cache\_and\_performance" Link to this property "account\_and\_billing" Link to this property "other" Link to this property

Link to this property is\_selectable: optional boolean Whether the caller can select this permission group when creating a token. Link to this property name: optional string Permission Group Name Link to this property

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" Link to this property "com.cloudflare.api.account.zone" Link to this property "com.cloudflare.api.user" Link to this property "com.cloudflare.edge.r2.bucket" Link to this property

Link to this property

[Link to this property](<#(resource)%20user.tokens.permission_groups%20%3E%20(model)%20permission_group_list_response%20%3E%20(schema)>) #### UserTokensValue ##### [Roll Token](https://developers.cloudflare.com/api/resources/user/subresources/tokens/subresources/value/methods/update) PUT/user/tokens/{token\_id}/value