--- title: User --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # User ##### [User Details](https://developers.cloudflare.com/api/typescript/resources/user/methods/get) client.user.get(RequestOptionsoptions?): [UserGetResponse]() {id, email, betas, 12 more } GET/user ##### [Edit User](https://developers.cloudflare.com/api/typescript/resources/user/methods/edit) client.user.edit(UserEditParams {country, first\_name, last\_name, 2 more } body, RequestOptionsoptions?): [UserEditResponse]() {id, email, betas, 12 more } PATCH/user ##### ModelsExpand Collapse
UserGetResponse {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?: Array<string> Lists the betas that the user is participating in. Link to this property country?: string| null The country in which the user lives. maxLength30 Link to this property first\_name?: string| null User’s first name maxLength60 Link to this property has\_business\_zones?: boolean Indicates whether user has any business zones Link to this property has\_enterprise\_zones?: boolean Indicates whether user has any enterprise zones Link to this property has\_pro\_zones?: boolean Indicates whether user has any pro zones Link to this property last\_name?: string| null User’s last name maxLength60 Link to this property
organizations?: Array<Organization {id, name, permissions, 2 more } > id?: string Identifier maxLength32 minLength32 Link to this property name?: string Organization name. maxLength100 Link to this property permissions?: Array<Permission> Access permissions for this User. Link to this property roles?: Array<string> List of roles that a user has within an organization. Link to this property status?: Status Whether the user is a member of the organization or has an invitation pending. Link to this property
Link to this property suspended?: boolean Indicates whether user has been suspended Link to this property telephone?: string| null User’s telephone number maxLength20 Link to this property two\_factor\_authentication\_enabled?: 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?: 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?: string| null 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 {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?: Array<string> Lists the betas that the user is participating in. Link to this property country?: string| null The country in which the user lives. maxLength30 Link to this property first\_name?: string| null User’s first name maxLength60 Link to this property has\_business\_zones?: boolean Indicates whether user has any business zones Link to this property has\_enterprise\_zones?: boolean Indicates whether user has any enterprise zones Link to this property has\_pro\_zones?: boolean Indicates whether user has any pro zones Link to this property last\_name?: string| null User’s last name maxLength60 Link to this property
organizations?: Array<Organization {id, name, permissions, 2 more } > id?: string Identifier maxLength32 minLength32 Link to this property name?: string Organization name. maxLength100 Link to this property permissions?: Array<Permission> Access permissions for this User. Link to this property roles?: Array<string> List of roles that a user has within an organization. Link to this property status?: Status Whether the user is a member of the organization or has an invitation pending. Link to this property
Link to this property suspended?: boolean Indicates whether user has been suspended Link to this property telephone?: string| null User’s telephone number maxLength20 Link to this property two\_factor\_authentication\_enabled?: 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?: 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?: string| null 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_edit_response%20%3E%20(schema)>) #### UserAudit Logs ##### [Get user audit logs](https://developers.cloudflare.com/api/typescript/resources/user/subresources/audit_logs/methods/list) client.user.auditLogs.list(AuditLogListParams {id, action, actor, 8 more } query?, RequestOptionsoptions?): V4PagePaginationArray< [AuditLog]() {id, action, actor, 7 more } > GET/user/audit\_logs #### UserBilling #### UserBillingHistory ##### [Billing History Details](https://developers.cloudflare.com/api/typescript/resources/user/subresources/billing/subresources/history/methods/list) Deprecated client.user.billing.history.list(HistoryListParams {action, occurred\_at, order, 3 more } query?, RequestOptionsoptions?): V4PagePaginationArray< [BillingHistory]() {id, action, amount, 5 more } > GET/user/billing/history ##### ModelsExpand Collapse
BillingHistory {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: Zone {name } name?: 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/typescript/resources/user/subresources/billing/subresources/profile/methods/get) Deprecated client.user.billing.profile.get(RequestOptionsoptions?): [ProfileGetResponse]() {id, account\_type, address, 35 more } GET/user/billing/profile ##### ModelsExpand Collapse
ProfileGetResponse {id, account\_type, address, 35 more } id?: string Billing item identifier tag. maxLength32 Link to this property account\_type?: string Link to this property address?: string Link to this property address2?: string Link to this property balance?: string Link to this property card\_expiry\_month?: number Link to this property card\_expiry\_year?: number Link to this property card\_number?: string Link to this property city?: string Link to this property company?: string Link to this property country?: string Link to this property created\_on?: string formatdate-time Link to this property device\_data?: string Link to this property edited\_on?: string formatdate-time Link to this property enterprise\_billing\_email?: string Link to this property enterprise\_primary\_email?: string Link to this property first\_name?: string Link to this property is\_partner?: boolean Link to this property last\_name?: string Link to this property next\_bill\_date?: string formatdate-time Link to this property payment\_address?: string Link to this property payment\_address2?: string Link to this property payment\_city?: string Link to this property payment\_country?: string Link to this property payment\_email?: string Link to this property payment\_first\_name?: string Link to this property payment\_gateway?: string Link to this property payment\_last\_name?: string Link to this property payment\_nonce?: string Link to this property payment\_state?: string Link to this property payment\_zipcode?: string Link to this property primary\_email?: string Link to this property state?: string Link to this property tax\_id\_type?: string Link to this property telephone?: string Link to this property validation\_code?: string Link to this property vat?: string Link to this property zipcode?: 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/typescript/resources/user/subresources/invites/methods/list) client.user.invites.list(RequestOptionsoptions?): SinglePage< [Invite]() {invited\_member\_id, organization\_id, id, 8 more } > GET/user/invites ##### [Invitation Details](https://developers.cloudflare.com/api/typescript/resources/user/subresources/invites/methods/get) client.user.invites.get(stringinviteID, RequestOptionsoptions?): [Invite]() {invited\_member\_id, organization\_id, id, 8 more } GET/user/invites/{invite\_id} ##### [Respond to Invitation](https://developers.cloudflare.com/api/typescript/resources/user/subresources/invites/methods/edit) client.user.invites.edit(stringinviteID, InviteEditParams {status } body, RequestOptionsoptions?): [Invite]() {invited\_member\_id, organization\_id, id, 8 more } PATCH/user/invites/{invite\_id} ##### ModelsExpand Collapse
Invite {invited\_member\_id, organization\_id, id, 8 more } invited\_member\_id: string| null 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?: string Invite identifier tag. maxLength32 Link to this property expires\_on?: string When the invite is no longer active. formatdate-time Link to this property invited\_by?: string The email address of the user who created the invite. maxLength90 Link to this property invited\_member\_email?: string Email address of the user to add to the organization. maxLength90 Link to this property invited\_on?: string When the invite was sent. formatdate-time Link to this property organization\_is\_enforcing\_twofactor?: boolean Link to this property organization\_name?: string Organization name. maxLength100 Link to this property roles?: Array<string> List of role names the membership has for this account. Link to this property
status?: "pending"| "accepted"| "rejected"| "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/typescript/resources/user/subresources/organizations/methods/list) Deprecated client.user.organizations.list(OrganizationListParams {direction, match, name, 4 more } query?, RequestOptionsoptions?): V4PagePaginationArray< [Organization]() {id, name, permissions, 2 more } > GET/user/organizations ##### [Organization Details](https://developers.cloudflare.com/api/typescript/resources/user/subresources/organizations/methods/get) Deprecated client.user.organizations.get(stringorganizationID, RequestOptionsoptions?): [OrganizationGetResponse]() GET/user/organizations/{organization\_id} ##### [Leave Organization](https://developers.cloudflare.com/api/typescript/resources/user/subresources/organizations/methods/delete) Deprecated client.user.organizations.delete(stringorganizationID, RequestOptionsoptions?): [OrganizationDeleteResponse]() {id } DELETE/user/organizations/{organization\_id} ##### ModelsExpand Collapse
Organization {id, name, permissions, 2 more } id?: string Identifier maxLength32 minLength32 Link to this property name?: string Organization name. maxLength100 Link to this property permissions?: Array<Permission> Access permissions for this User. Link to this property roles?: Array<string> List of roles that a user has within an organization. Link to this property status?: Status Whether the user is a member of the organization or has an invitation pending. Link to this property
[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 {id } id?: 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/typescript/resources/user/subresources/spectrum_analytics/subresources/zones/subresources/reports/methods/get) client.user.spectrumAnalytics.zones.reports.get(ReportGetParams {cdn\_traffic, since, until } query?, RequestOptionsoptions?): [ReportGetResponse]() {totals, zone\_id } GET/user/spectrum\_analytics/zones/report ##### ModelsExpand Collapse
ReportGetResponse = Array<ReportGetResponseItem>
totals: Totals {bandwidth }
bandwidth: Bandwidth {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/typescript/resources/user/subresources/subscriptions/methods/get) client.user.subscriptions.get(RequestOptionsoptions?): SinglePage< [Subscription]() {id, currency, current\_period\_end, 5 more } > GET/user/subscriptions ##### [Update User Subscription](https://developers.cloudflare.com/api/typescript/resources/user/subresources/subscriptions/methods/update) client.user.subscriptions.update(stringidentifier, SubscriptionUpdateParams {frequency, rate\_plan } body, RequestOptionsoptions?): [SubscriptionUpdateResponse]() PUT/user/subscriptions/{identifier} ##### [Delete User Subscription](https://developers.cloudflare.com/api/typescript/resources/user/subresources/subscriptions/methods/delete) client.user.subscriptions.delete(stringidentifier, RequestOptionsoptions?): [SubscriptionDeleteResponse]() {subscription\_id } DELETE/user/subscriptions/{identifier} ##### ModelsExpand Collapse
SubscriptionUpdateResponse = unknown| string| null One of the following: unknown Link to this property string| null Link to this property
[Link to this property](<#(resource)%20user.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)>)
SubscriptionDeleteResponse {subscription\_id } subscription\_id?: 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/typescript/resources/user/subresources/tenants/methods/list) client.user.tenants.list(RequestOptionsoptions?): SinglePage< [Organization]() {id, create\_time, meta, 3 more } > GET/user/tenants #### UserTokens ##### [List Tokens](https://developers.cloudflare.com/api/typescript/resources/user/subresources/tokens/methods/list) client.user.tokens.list(TokenListParams {direction, include\_expired, page, per\_page } query?, RequestOptionsoptions?): V4PagePaginationArray< [Token]() {id, condition, creator\_email\_at\_creation, 10 more } > GET/user/tokens ##### [Token Details](https://developers.cloudflare.com/api/typescript/resources/user/subresources/tokens/methods/get) client.user.tokens.get(stringtokenID, RequestOptionsoptions?): [Token]() {id, condition, creator\_email\_at\_creation, 10 more } GET/user/tokens/{token\_id} ##### [Create Token](https://developers.cloudflare.com/api/typescript/resources/user/subresources/tokens/methods/create) client.user.tokens.create(TokenCreateParams {name, policies, condition, 2 more } body, RequestOptionsoptions?): [TokenCreateResponse]() {id, condition, creator\_email\_at\_creation, 11 more } POST/user/tokens ##### [Update Token](https://developers.cloudflare.com/api/typescript/resources/user/subresources/tokens/methods/update) client.user.tokens.update(stringtokenID, TokenUpdateParams {name, policies, condition, 3 more } body, RequestOptionsoptions?): [Token]() {id, condition, creator\_email\_at\_creation, 10 more } PUT/user/tokens/{token\_id} ##### [Delete Token](https://developers.cloudflare.com/api/typescript/resources/user/subresources/tokens/methods/delete) client.user.tokens.delete(stringtokenID, RequestOptionsoptions?): [TokenDeleteResponse]() {id } | null DELETE/user/tokens/{token\_id} ##### [Verify Token](https://developers.cloudflare.com/api/typescript/resources/user/subresources/tokens/methods/verify) client.user.tokens.verify(RequestOptionsoptions?): [TokenVerifyResponse]() {id, status, expires\_on, not\_before } GET/user/tokens/verify ##### ModelsExpand Collapse
TokenCreateResponse {id, condition, creator\_email\_at\_creation, 11 more } id?: string Token identifier tag. maxLength32 Link to this property
condition?: Condition {request\_ip }
request\_ip?: RequestIP {in, not\_in } Client IP restrictions. in?: Array<TokenConditionCIDRList> List of IPv4/IPv6 CIDR addresses. Link to this property not\_in?: Array<TokenConditionCIDRList> List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property creator\_email\_at\_creation?: 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?: string The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property issued\_on?: string The time on which the token was created. formatdate-time Link to this property last\_used\_on?: string Last time the token was used. formatdate-time Link to this property modified\_on?: string Last time the token was modified. formatdate-time Link to this property name?: string Token name. maxLength120 Link to this property not\_before?: string The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
policies?: Array<TokenPolicy {id, effect, permission\_groups, resources } > List of access policies assigned to the token. id: string Policy identifier. Link to this property
effect: "allow"| "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<PermissionGroup> A set of permission groups that are specified to the policy. id: string Identifier of the permission group. Link to this property
meta?: Meta {category, deprecated, description, 5 more } Attributes associated to the permission group. category?: string A category used to group permission groups. Link to this property deprecated?: string Indicates whether the permission group is deprecated. Link to this property description?: string Additional information about the permission group. Link to this property editable?: string Indicates whether the permission group can be edited. Link to this property eol\_at?: string The planned end-of-life date and time, when provided. formatdate-time Link to this property label?: string A label identifying the permission group. Link to this property scopes?: string The scope associated with the permission group. Link to this property visibility?: string Indicates the permission group’s availability or visibility. Link to this property
Link to this property name?: string Name of the permission group. Link to this property
Link to this property
resources: Record<string, string>| Record<string, Record<string, string>> A list of resource names that the policy applies to. One of the following: Record<string, string> Link to this property Record<string, Record<string, string>> Link to this property
Link to this property
Link to this property provisioner\_id?: string| null 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?: string The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
status?: "active"| "disabled"| "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?: 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 {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 {id, status, expires\_on, not\_before } id: string Token identifier tag. maxLength32 Link to this property
status: "active"| "disabled"| "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?: string The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property not\_before?: 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/typescript/resources/user/subresources/tokens/subresources/permission_groups/methods/list) client.user.tokens.permissionGroups.list(PermissionGroupListParams {name, scope } query?, RequestOptionsoptions?): SinglePage< [PermissionGroupListResponse]() {id, category, is\_selectable, 2 more } > GET/user/tokens/permission\_groups ##### ModelsExpand Collapse
PermissionGroupListResponse {id, category, is\_selectable, 2 more } id?: string Public ID. Link to this property
category?: "developer\_platform"| "ai\_and\_machine\_learning"| "dns\_and\_zones"| 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?: boolean Whether the caller can select this permission group when creating a token. Link to this property name?: string Permission Group Name Link to this property
scopes?: Array<"com.cloudflare.api.account"| "com.cloudflare.api.account.zone"| "com.cloudflare.api.user"| "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/typescript/resources/user/subresources/tokens/subresources/value/methods/update) client.user.tokens.value.update(stringtokenID, RequestOptionsoptions?): [TokenValue]() PUT/user/tokens/{token\_id}/value