--- title: User --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # User ##### [User Details](https://developers.cloudflare.com/api/python/resources/user/methods/get) user.get() -> [UserGetResponse]() GET/user ##### [Edit User](https://developers.cloudflare.com/api/python/resources/user/methods/edit) user.edit(UserEditParams\*\*kwargs) -> [UserEditResponse]() PATCH/user ##### ModelsExpand Collapse
class UserGetResponse: … id: str Identifier of the user. Link to this property email: str Current email address of the user. formatemail Link to this property betas: Optional\[List\[str]] Lists the betas that the user is participating in. Link to this property country: Optional\[str] The country in which the user lives. maxLength30 Link to this property first\_name: Optional\[str] User’s first name maxLength60 Link to this property has\_business\_zones: Optional\[bool] Indicates whether user has any business zones Link to this property has\_enterprise\_zones: Optional\[bool] Indicates whether user has any enterprise zones Link to this property has\_pro\_zones: Optional\[bool] Indicates whether user has any pro zones Link to this property last\_name: Optional\[str] User’s last name maxLength60 Link to this property
organizations: Optional\[List\[Organization]] id: Optional\[str] Identifier maxLength32 minLength32 Link to this property name: Optional\[str] Organization name. maxLength100 Link to this property permissions: Optional\[List\[Permission]] Access permissions for this User. Link to this property roles: Optional\[List\[str]] 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\[bool] Indicates whether user has been suspended Link to this property telephone: Optional\[str] User’s telephone number maxLength20 Link to this property two\_factor\_authentication\_enabled: Optional\[bool] 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\[bool] 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\[str] 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)>)
class UserEditResponse: … id: str Identifier of the user. Link to this property email: str Current email address of the user. formatemail Link to this property betas: Optional\[List\[str]] Lists the betas that the user is participating in. Link to this property country: Optional\[str] The country in which the user lives. maxLength30 Link to this property first\_name: Optional\[str] User’s first name maxLength60 Link to this property has\_business\_zones: Optional\[bool] Indicates whether user has any business zones Link to this property has\_enterprise\_zones: Optional\[bool] Indicates whether user has any enterprise zones Link to this property has\_pro\_zones: Optional\[bool] Indicates whether user has any pro zones Link to this property last\_name: Optional\[str] User’s last name maxLength60 Link to this property
organizations: Optional\[List\[Organization]] id: Optional\[str] Identifier maxLength32 minLength32 Link to this property name: Optional\[str] Organization name. maxLength100 Link to this property permissions: Optional\[List\[Permission]] Access permissions for this User. Link to this property roles: Optional\[List\[str]] 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\[bool] Indicates whether user has been suspended Link to this property telephone: Optional\[str] User’s telephone number maxLength20 Link to this property two\_factor\_authentication\_enabled: Optional\[bool] 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\[bool] 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\[str] 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/python/resources/user/subresources/audit_logs/methods/list) user.audit\_logs.list(AuditLogListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[AuditLog]()] GET/user/audit\_logs #### UserBilling #### UserBillingHistory ##### [Billing History Details](https://developers.cloudflare.com/api/python/resources/user/subresources/billing/subresources/history/methods/list) Deprecated user.billing.history.list(HistoryListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[BillingHistory]()] GET/user/billing/history ##### ModelsExpand Collapse
class BillingHistory: … id: str Billing item identifier tag. maxLength32 Link to this property action: str The billing item action. maxLength30 Link to this property amount: float The amount associated with this billing item. Link to this property currency: str The monetary unit in which pricing information is displayed. Link to this property description: str The billing item description. maxLength255 Link to this property occurred\_at: datetime When the billing item was created. formatdate-time Link to this property type: str The billing item type. maxLength30 Link to this property
zone: Zone name: Optional\[str] 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/python/resources/user/subresources/billing/subresources/profile/methods/get) Deprecated user.billing.profile.get() -> [ProfileGetResponse]() GET/user/billing/profile ##### ModelsExpand Collapse
class ProfileGetResponse: … id: Optional\[str] Billing item identifier tag. maxLength32 Link to this property account\_type: Optional\[str] Link to this property address: Optional\[str] Link to this property address2: Optional\[str] Link to this property balance: Optional\[str] Link to this property card\_expiry\_month: Optional\[int] Link to this property card\_expiry\_year: Optional\[int] Link to this property card\_number: Optional\[str] Link to this property city: Optional\[str] Link to this property company: Optional\[str] Link to this property country: Optional\[str] Link to this property created\_on: Optional\[datetime] formatdate-time Link to this property device\_data: Optional\[str] Link to this property edited\_on: Optional\[datetime] formatdate-time Link to this property enterprise\_billing\_email: Optional\[str] Link to this property enterprise\_primary\_email: Optional\[str] Link to this property first\_name: Optional\[str] Link to this property is\_partner: Optional\[bool] Link to this property last\_name: Optional\[str] Link to this property next\_bill\_date: Optional\[datetime] formatdate-time Link to this property payment\_address: Optional\[str] Link to this property payment\_address2: Optional\[str] Link to this property payment\_city: Optional\[str] Link to this property payment\_country: Optional\[str] Link to this property payment\_email: Optional\[str] Link to this property payment\_first\_name: Optional\[str] Link to this property payment\_gateway: Optional\[str] Link to this property payment\_last\_name: Optional\[str] Link to this property payment\_nonce: Optional\[str] Link to this property payment\_state: Optional\[str] Link to this property payment\_zipcode: Optional\[str] Link to this property primary\_email: Optional\[str] Link to this property state: Optional\[str] Link to this property tax\_id\_type: Optional\[str] Link to this property telephone: Optional\[str] Link to this property validation\_code: Optional\[str] Link to this property vat: Optional\[str] Link to this property zipcode: Optional\[str] 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/python/resources/user/subresources/invites/methods/list) user.invites.list() -> SyncSinglePage\[[Invite]()] GET/user/invites ##### [Invitation Details](https://developers.cloudflare.com/api/python/resources/user/subresources/invites/methods/get) user.invites.get(strinvite\_id) -> [Invite]() GET/user/invites/{invite\_id} ##### [Respond to Invitation](https://developers.cloudflare.com/api/python/resources/user/subresources/invites/methods/edit) user.invites.edit(strinvite\_id, InviteEditParams\*\*kwargs) -> [Invite]() PATCH/user/invites/{invite\_id} ##### ModelsExpand Collapse
class Invite: … invited\_member\_id: Optional\[str] ID of the user to add to the organization. maxLength32 Link to this property organization\_id: str ID of the organization the user will be added to. maxLength32 Link to this property id: Optional\[str] Invite identifier tag. maxLength32 Link to this property expires\_on: Optional\[datetime] When the invite is no longer active. formatdate-time Link to this property invited\_by: Optional\[str] The email address of the user who created the invite. maxLength90 Link to this property invited\_member\_email: Optional\[str] Email address of the user to add to the organization. maxLength90 Link to this property invited\_on: Optional\[datetime] When the invite was sent. formatdate-time Link to this property organization\_is\_enforcing\_twofactor: Optional\[bool] Link to this property organization\_name: Optional\[str] Organization name. maxLength100 Link to this property roles: Optional\[List\[str]] List of role names the membership has for this account. Link to this property
status: Optional\[Literal\["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/python/resources/user/subresources/organizations/methods/list) Deprecated user.organizations.list(OrganizationListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Organization]()] GET/user/organizations ##### [Organization Details](https://developers.cloudflare.com/api/python/resources/user/subresources/organizations/methods/get) Deprecated user.organizations.get(strorganization\_id) -> object GET/user/organizations/{organization\_id} ##### [Leave Organization](https://developers.cloudflare.com/api/python/resources/user/subresources/organizations/methods/delete) Deprecated user.organizations.delete(strorganization\_id) -> [OrganizationDeleteResponse]() DELETE/user/organizations/{organization\_id} ##### ModelsExpand Collapse
class Organization: … id: Optional\[str] Identifier maxLength32 minLength32 Link to this property name: Optional\[str] Organization name. maxLength100 Link to this property permissions: Optional\[List\[Permission]] Access permissions for this User. Link to this property roles: Optional\[List\[str]] 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](<#(resource)%20user.organizations%20%3E%20(model)%20organization%20%3E%20(schema)>)
class OrganizationDeleteResponse: … id: Optional\[str] 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/python/resources/user/subresources/spectrum_analytics/subresources/zones/subresources/reports/methods/get) user.spectrum\_analytics.zones.reports.get(ReportGetParams\*\*kwargs) -> [ReportGetResponse]() GET/user/spectrum\_analytics/zones/report ##### ModelsExpand Collapse
List\[ReportGetResponseItem]
totals: ReportGetResponseItemTotals
bandwidth: ReportGetResponseItemTotalsBandwidth all: float Sum of ingress and egress bytes transferred. Link to this property egress: float Sum of egress bytes transferred. Link to this property ingress: float Sum of ingress bytes transferred. Link to this property
Link to this property
Link to this property zone\_id: str 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/python/resources/user/subresources/subscriptions/methods/get) user.subscriptions.get() -> SyncSinglePage\[[Subscription]()] GET/user/subscriptions ##### [Update User Subscription](https://developers.cloudflare.com/api/python/resources/user/subresources/subscriptions/methods/update) user.subscriptions.update(stridentifier, SubscriptionUpdateParams\*\*kwargs) -> [SubscriptionUpdateResponse]() PUT/user/subscriptions/{identifier} ##### [Delete User Subscription](https://developers.cloudflare.com/api/python/resources/user/subresources/subscriptions/methods/delete) user.subscriptions.delete(stridentifier) -> [SubscriptionDeleteResponse]() DELETE/user/subscriptions/{identifier} ##### ModelsExpand Collapse
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20user.subscriptions%20%3E%20(model)%20subscription_update_response%20%3E%20(schema)>)
class SubscriptionDeleteResponse: … subscription\_id: Optional\[str] 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/python/resources/user/subresources/tenants/methods/list) user.tenants.list() -> SyncSinglePage\[[Organization]()] GET/user/tenants #### UserTokens ##### [List Tokens](https://developers.cloudflare.com/api/python/resources/user/subresources/tokens/methods/list) user.tokens.list(TokenListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Token]()] GET/user/tokens ##### [Token Details](https://developers.cloudflare.com/api/python/resources/user/subresources/tokens/methods/get) user.tokens.get(strtoken\_id) -> [Token]() GET/user/tokens/{token\_id} ##### [Create Token](https://developers.cloudflare.com/api/python/resources/user/subresources/tokens/methods/create) user.tokens.create(TokenCreateParams\*\*kwargs) -> [TokenCreateResponse]() POST/user/tokens ##### [Update Token](https://developers.cloudflare.com/api/python/resources/user/subresources/tokens/methods/update) user.tokens.update(strtoken\_id, TokenUpdateParams\*\*kwargs) -> [Token]() PUT/user/tokens/{token\_id} ##### [Delete Token](https://developers.cloudflare.com/api/python/resources/user/subresources/tokens/methods/delete) user.tokens.delete(strtoken\_id) -> [TokenDeleteResponse]() DELETE/user/tokens/{token\_id} ##### [Verify Token](https://developers.cloudflare.com/api/python/resources/user/subresources/tokens/methods/verify) user.tokens.verify() -> [TokenVerifyResponse]() GET/user/tokens/verify ##### ModelsExpand Collapse
class TokenCreateResponse: … id: Optional\[str] Token identifier tag. maxLength32 Link to this property
condition: Optional\[Condition]
request\_ip: Optional\[ConditionRequestIP] Client IP restrictions. in\_: Optional\[List\[TokenConditionCIDRList]] List of IPv4/IPv6 CIDR addresses. Link to this property not\_in: Optional\[List\[TokenConditionCIDRList]] List of IPv4/IPv6 CIDR addresses. Link to this property
Link to this property
Link to this property creator\_email\_at\_creation: Optional\[str] 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\[datetime] The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property issued\_on: Optional\[datetime] The time on which the token was created. formatdate-time Link to this property last\_used\_on: Optional\[datetime] Last time the token was used. formatdate-time Link to this property modified\_on: Optional\[datetime] Last time the token was modified. formatdate-time Link to this property name: Optional\[str] Token name. maxLength120 Link to this property not\_before: Optional\[datetime] The time before which the token MUST NOT be accepted for processing. formatdate-time Link to this property
policies: Optional\[List\[TokenPolicy]] List of access policies assigned to the token. id: str Policy identifier. Link to this property
effect: Literal\["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: List\[PermissionGroup] A set of permission groups that are specified to the policy. id: str Identifier of the permission group. Link to this property
meta: Optional\[PermissionGroupMeta] Attributes associated to the permission group. category: Optional\[str] A category used to group permission groups. Link to this property deprecated: Optional\[str] Indicates whether the permission group is deprecated. Link to this property description: Optional\[str] Additional information about the permission group. Link to this property editable: Optional\[str] Indicates whether the permission group can be edited. Link to this property eol\_at: Optional\[datetime] The planned end-of-life date and time, when provided. formatdate-time Link to this property label: Optional\[str] A label identifying the permission group. Link to this property scopes: Optional\[str] The scope associated with the permission group. Link to this property visibility: Optional\[str] Indicates the permission group’s availability or visibility. Link to this property
Link to this property name: Optional\[str] Name of the permission group. Link to this property
Link to this property
resources: Union\[Dict\[str, str], Dict\[str, Dict\[str, str]]] A list of resource names that the policy applies to. One of the following: Dict\[str, str] Map of simple string resource permissions Link to this property Dict\[str, Dict\[str, str]] Map of nested resource permissions Link to this property
Link to this property
Link to this property provisioner\_id: Optional\[str] 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\[str] The type of service that provisioned the token. Only present for provisioned Account Owned API Tokens. Link to this property
status: Optional\[Literal\["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: 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)>)
class TokenDeleteResponse: … id: str 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)>)
class TokenVerifyResponse: … id: str Token identifier tag. maxLength32 Link to this property
status: Literal\["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: Optional\[datetime] The expiration time on or after which the JWT MUST NOT be accepted for processing. formatdate-time Link to this property not\_before: Optional\[datetime] 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/python/resources/user/subresources/tokens/subresources/permission_groups/methods/list) user.tokens.permission\_groups.list(PermissionGroupListParams\*\*kwargs) -> SyncSinglePage\[[PermissionGroupListResponse]()] GET/user/tokens/permission\_groups ##### ModelsExpand Collapse
class PermissionGroupListResponse: … id: Optional\[str] Public ID. Link to this property
category: Optional\[Literal\["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: Optional\[bool] Whether the caller can select this permission group when creating a token. Link to this property name: Optional\[str] Permission Group Name Link to this property
scopes: Optional\[List\[Literal\["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/python/resources/user/subresources/tokens/subresources/value/methods/update) user.tokens.value.update(strtoken\_id) -> [TokenValue]() PUT/user/tokens/{token\_id}/value