/** Scopes requestable from the `cf` CLI's public Cloudflare OAuth client. */
export const OAUTH_SCOPE_GROUPS = [
{
id: "developer-platform",
label: "Developer Platform",
scopes: [
"agent-memory.write",
"browser-rendering.read",
"browser-rendering.write",
"cf-agents.read",
"cf-agents.write",
"cloud-connector.read",
"cloud-connector.write",
"cloudchamber.read",
"cloudchamber.write",
"constellation.read",
"constellation.write",
"d1.read",
"d1.write",
"flagship.evaluate",
"flagship.read",
"flagship.write",
"query-cache.read",
"query-cache.write",
"k2.read",
"k2.write",
"k2.consume",
"k2.produce",
"mcp-portals.read",
"mcp-portals.write",
"messaging.edit",
"messaging.read",
"page.read",
"page.write",
"pipelines.read",
"pipelines.send",
"pipelines.write",
"pubsub.read",
"pubsub.write",
"queues.read",
"queues.write",
"realtime.write",
"realtime.admin",
"realtime.read",
"secrets-store.read",
"secrets-store.write",
"vectorize.read",
"vectorize.write",
"workers-ci.read",
"workers-ci.write",
"containers.read",
"containers.write",
"workers-kv-storage.read",
"workers-kv-storage.write",
"workers-observability.read",
"workers-observability-telemetry.write",
"workers-observability.write",
"r2-catalog.read",
"r2-catalog.write",
"r2-catalog-sql.read",
"workers-r2-bucket-item.read",
"workers-r2-bucket-item.write",
"workers-r2.read",
"workers-r2.write",
"workers-routes.read",
"workers-routes.write",
"workers-scripts.read",
"workers-scripts.write",
"workers-tail.read",
"d1.metadata_read",
"messaging.metadata_read",
"pages.metadata_read",
"queues.metadata_read",
"workers-kv-storage.metadata_read",
"workers-r2.metadata_read",
"workers-scripts.bind",
],
},
{
id: "ai-machine-learning",
label: "AI & Machine Learning",
scopes: [
"agw.read",
"agw.run",
"agw.write",
"aiaudit.read",
"aiaudit.write",
"aig.read",
"aig.run",
"aig.write",
"ai-search.index",
"ai-search.read",
"ai-search.run",
"ai-search.write",
"rag.read",
"rag.write",
"rag.run",
"firewall-for-ai.read",
"firewall-for-ai.write",
"websearch.read",
"websearch.run",
"websearch.write",
"ai.read",
"ai.write",
"ai-search.metadata_read",
"aig.metadata_read",
"websearch.metadata_read",
"workers_ai.metadata_read",
],
},
{
id: "dns-zones",
label: "DNS & Zones",
scopes: [
"account-dns-settings.read",
"account-dns-settings.write",
"dns-firewall.read",
"dns-firewall.write",
"dns.read",
"dns-view.read",
"dns-view.write",
"dns.write",
"registrar-domains.admin",
"registrar-domains.read",
"registrar-sandbox-domains.admin",
"registrar-sandbox-domains.read",
"zone-custom-asset.read",
"zone-custom-asset.write",
"zone-dns-settings.read",
"zone-dns-settings.write",
"zone.read",
"zone-settings.read",
"zone-settings.write",
"zone-versioning.read",
"zone-versioning.write",
"zone.write",
],
},
{
id: "app-security",
label: "App Security",
scopes: [
"fraud-detection-pii.read",
"account-firewall-access-rules.read",
"account-firewall-access-rules.write",
"account-security-center-insights.read",
"account-security-center-insights.write",
"account-waf.read",
"account-waf.write",
"request-tracer.read",
"reports-application-security-report.read",
"bot-management-feedback.read",
"bot-management-feedback.write",
"bot-management.read",
"bot-management.write",
"cloudforce-one.read",
"cloudforce-one.write",
"ddos-botnet-feed.read",
"ddos-botnet-feed.write",
"ddos-protection.read",
"ddos-protection.write",
"api-gateway.write",
"api-gateway.read",
"domain-page.shield",
"domain-page-shield.read",
"field-extractor.read",
"field-extractor.write",
"firewall-services.read",
"firewall-services.write",
"fraud-detection.read",
"fraud-detection.write",
"fraud-events.write",
"fraud-feedback.read",
"fraud-feedback.write",
"http-applications.read",
"http-applications.write",
"http-ddos-managed-ruleset.read",
"http-ddos-managed-ruleset.write",
"iot.read",
"iot.write",
"l4-ddos-managed-ruleset.read",
"l4-ddos-managed-ruleset.write",
"page-rules.read",
"page-rules.write",
"page.shield",
"page-shield.read",
"precursor.read",
"precursor.write",
"sanitize.read",
"sanitize.write",
"tag.read",
"tag.write",
"trust-and-safety.read",
"trust-and-safety.write",
"challenge-widgets.read",
"challenge-widgets.write",
"url-scanner.read",
"url-scanner.write",
"zaraz.write",
"zaraz.edit",
"zaraz.read",
"zone-security-center-insights.read",
"zone-security-center-insights.write",
"zone-waf.read",
"zone-waf.write",
],
},
{
id: "rules-configuration",
label: "Rules & Configuration",
scopes: [
"account-custom-error-rules.read",
"account-custom-error-rules.write",
"account-custom-pages.read",
"account-custom-pages.write",
"account-rule-lists.read",
"account-rule-lists.write",
"account-rulesets.read",
"account-rulesets.write",
"config-settings.read",
"config-settings.write",
"custom-errors.read",
"custom-errors.write",
"custom-pages.read",
"custom-pages.write",
"dynamic-redirect.read",
"dynamic-redirect.write",
"managed-headers.read",
"managed-headers.write",
"mass-url-redirects.read",
"mass-url-redirects.write",
"origin.read",
"origin.write",
"payments-gateway.read",
"payments-gateway.write",
"response-compression.read",
"response-compression.write",
"select-configuration.read",
"select-configuration.write",
"snippets.read",
"snippets.write",
"transform-rules.read",
"transform-rules.write",
"zone-transform-rules.read",
"zone-transform-rules.write",
],
},
{
id: "zero-trust",
label: "Cloudflare One / Zero Trust",
scopes: [
"access.read",
"zone-access.read",
"access.revoke",
"zone-access.revoke",
"access.write",
"zone-access.write",
"access-app.read",
"access-app.revoke",
"access-app.write",
"access-audit-log.read",
"access-custom-page.read",
"access-custom-page.write",
"access-device-posture.read",
"access-device-posture.write",
"access-group.read",
"access-group.write",
"access-idp.read",
"access-idp.write",
"access-key.read",
"access-key.write",
"access-certificate.read",
"access-certificate.write",
"access-org.read",
"access-org.revoke",
"access-org.write",
"access-acct.read",
"access-acct.revoke",
"access-acct.write",
"access-policy.read",
"access-policy.write",
"access-policy-test.read",
"access-policy-test.write",
"access-saml-certificate.read",
"access-saml-certificate.write",
"access-scim-log.read",
"access-population.read",
"access-population.write",
"access-service-token.read",
"access-service-token.write",
"access-ssh-auditing.read",
"access-ssh-auditing.write",
"access-tag.read",
"access-tag.write",
"access-users.read",
"access-users.write",
"casb.read",
"casb.write",
"teams-cds-compute-account.read",
"teams-cds-compute-account.write",
"teams-dex.read",
"teams-dex.write",
"teams-connector-cloudflared.monitoring",
"teams-connector-cloudflared.read",
"teams-connector-cloudflared.write",
"teams-connector-warp.read",
"teams-connector-warp.write",
"teams-connectors.read",
"teams-connectors.write",
"teams-networks.read",
"teams-networks.write",
"argotunnel.read",
"argotunnel.write",
"teams-secure.location",
"dls.read",
"dls.write",
"teams.read",
"teams.report",
"teams-resilience.read",
"teams-resilience.write",
"teams.write",
"teams-pii.read",
"access-seats.write",
],
},
{
id: "analytics-logs",
label: "Analytics & Logs",
scopes: [
"account-analytics.read",
"analytics.read",
"intel.read",
"intel.write",
"account-logs.read",
"logs.read",
"account-logs.write",
"logs.write",
"radar.read",
"zone-observability.read",
"zone-observability.write",
],
},
{
id: "network-services",
label: "Network Services",
scopes: [
"account-waiting-rooms.read",
"address-maps.read",
"address-maps.write",
"chinanetwork-steering.read",
"chinanetwork-steering.write",
"connectivity-directory.admin",
"connectivity-directory.bind",
"connectivity-directory.read",
"healthcheck.read",
"healthcheck.write",
"ip-prefix-bgp-on-demand.read",
"ip-prefix-bgp-on-demand.write",
"ip-prefix.read",
"ip-prefix.write",
"load-balancers-account.read",
"load-balancers-account.write",
"load-balancers.read",
"load-balancers.write",
"load-balancing-monitors-and-pools.read",
"load-balancing-monitors-and-pools.write",
"pcaps-api.read",
"pcaps-api.write",
"magic-firewall.read",
"magic-firewall.write",
"fbm.admin",
"fbm.read",
"fbm.write",
"magic-transit.read",
"magic-transit.write",
"magic-wan.read",
"magic-wan.write",
"waiting-rooms.read",
"waiting-rooms.write",
"web3-hostnames.read",
"web3-hostnames.write",
],
},
{
id: "media",
label: "Media",
scopes: [
"calls.read",
"calls.write",
"images.read",
"images.write",
"moq.read",
"moq.write",
"stream.read",
"stream.write",
"images.metadata_read",
"stream.metadata_read",
],
},
{
id: "email-messaging",
label: "Email & Messaging",
scopes: [
"cloud-email-security.read",
"cloud-email-security.write",
"email-routing-account-rule.read",
"email-routing-address.read",
"email-routing-address.write",
"email-routing-rule.read",
"email-routing-rule.write",
"email-routing-suppression.read",
"email-routing-suppression.write",
"email-security-dmarcreports.read",
"email-security-dmarcreports.write",
"email-sending.read",
"email-sending.write",
],
},
{
id: "cache-performance",
label: "Cache & Performance",
scopes: [
"account-ssl-and-certificates.read",
"account-ssl-and-certificates.write",
"cache.purge",
"cache-settings.read",
"cache-settings.write",
"account-disable-esc.read",
"zone-disable-esc.read",
"account-disable-esc.write",
"zone-disable-esc.write",
"ssl-and-certificates.read",
"ssl-and-certificates.write",
],
},
{
id: "account-billing",
label: "Account & Billing",
scopes: [
"account-api-gateway.write",
"account-api-gateway.read",
"account-custom-asset.read",
"account-custom-asset.write",
"account_api_tokens:create",
"account-settings.read",
"account-settings.write",
"apps.write",
"integration.write",
"memberships.read",
"memberships.write",
"notifications.read",
"notifications.write",
"user-details.read",
"user-details.write",
],
},
{
id: "other",
label: "Other",
scopes: [
"artifacts.read",
"artifacts.write",
"resource-library.read",
"resource-library.write",
"resource-sharing.read",
],
},
] as const;
export type OAuthScopeId = (typeof OAUTH_SCOPE_GROUPS)[number]["scopes"][number];
/** Human-readable names from Cloudflare's OAuth scope catalog. */
export const OAUTH_SCOPE_NAMES: Readonly<Record<OAuthScopeId, string>> = {
"agent-memory.write": "Agent Memory Write",
"browser-rendering.read": "Browser Run Read",
"browser-rendering.write": "Browser Run Write",
"cf-agents.read": "CF Agents Read",
"cf-agents.write": "CF Agents Write",
"cloud-connector.read": "Cloud Connector Read",
"cloud-connector.write": "Cloud Connector Write",
"cloudchamber.read": "Cloudchamber Read",
"cloudchamber.write": "Cloudchamber Write",
"constellation.read": "Constellation Read",
"constellation.write": "Constellation Write",
"d1.read": "D1 Read",
"d1.write": "D1 Write",
"flagship.evaluate": "Flagship Evaluate",
"flagship.read": "Flagship Read",
"flagship.write": "Flagship Write",
"query-cache.read": "Hyperdrive Read",
"query-cache.write": "Hyperdrive Write",
"k2.read": "K2 Config Read",
"k2.write": "K2 Config Write",
"k2.consume": "K2 Consume",
"k2.produce": "K2 Produce",
"mcp-portals.read": "MCP Portals Read",
"mcp-portals.write": "MCP Portals Write",
"messaging.edit": "Messaging Edit",
"messaging.read": "Messaging Read",
"page.read": "Pages Read",
"page.write": "Pages Write",
"pipelines.read": "Pipelines Read",
"pipelines.send": "Pipelines Send",
"pipelines.write": "Pipelines Write",
"pubsub.read": "Pubsub Configuration Read",
"pubsub.write": "Pubsub Configuration Write",
"queues.read": "Queues Read",
"queues.write": "Queues Write",
"realtime.write": "Realtime",
"realtime.admin": "Realtime Admin",
"realtime.read": "Realtime Read",
"secrets-store.read": "Secrets Store Read",
"secrets-store.write": "Secrets Store Write",
"vectorize.read": "Vectorize Read",
"vectorize.write": "Vectorize Write",
"workers-ci.read": "Workers CI Read",
"workers-ci.write": "Workers CI Write",
"containers.read": "Workers Containers Read",
"containers.write": "Workers Containers Write",
"workers-kv-storage.read": "Workers KV Storage Read",
"workers-kv-storage.write": "Workers KV Storage Write",
"workers-observability.read": "Workers Observability Read",
"workers-observability-telemetry.write": "Workers Observability Telemetry Write",
"workers-observability.write": "Workers Observability Write",
"r2-catalog.read": "Workers R2 Data Catalog Read",
"r2-catalog.write": "Workers R2 Data Catalog Write",
"r2-catalog-sql.read": "Workers R2 SQL Read",
"workers-r2-bucket-item.read": "Workers R2 Storage Bucket Item Read",
"workers-r2-bucket-item.write": "Workers R2 Storage Bucket Item Write",
"workers-r2.read": "Workers R2 Storage Read",
"workers-r2.write": "Workers R2 Storage Write",
"workers-routes.read": "Workers Routes Read",
"workers-routes.write": "Workers Routes Write",
"workers-scripts.read": "Workers Scripts Read",
"workers-scripts.write": "Workers Scripts Write",
"workers-tail.read": "Workers Tail Read",
"agw.read": "Agents Gateway Read",
"agw.run": "Agents Gateway Run",
"agw.write": "Agents Gateway Write",
"aiaudit.read": "AI Audit Read",
"aiaudit.write": "AI Audit Write",
"aig.read": "AI Gateway Read",
"aig.run": "AI Gateway Run",
"aig.write": "AI Gateway Write",
"ai-search.index": "AI Search Index Engine",
"ai-search.read": "AI Search Read",
"ai-search.run": "AI Search Run",
"ai-search.write": "AI Search Write",
"rag.read": "Auto Rag Read",
"rag.write": "Auto Rag Write",
"rag.run": "Auto Rag Write Run Engine",
"firewall-for-ai.read": "Firewall for AI Read",
"firewall-for-ai.write": "Firewall for AI Write",
"websearch.read": "Websearch Read",
"websearch.run": "Websearch Run",
"websearch.write": "Websearch Write",
"ai.read": "Workers AI Read",
"ai.write": "Workers AI Write",
"account-dns-settings.read": "Account DNS Settings Read",
"account-dns-settings.write": "Account DNS Settings Write",
"dns-firewall.read": "DNS Firewall Read",
"dns-firewall.write": "DNS Firewall Write",
"dns.read": "DNS Read",
"dns-view.read": "DNS View Read",
"dns-view.write": "DNS View Write",
"dns.write": "DNS Write",
"registrar-domains.admin": "Registrar Domains Admin",
"registrar-domains.read": "Registrar Domains Read",
"registrar-sandbox-domains.admin": "Registrar Sandbox Domains Admin",
"registrar-sandbox-domains.read": "Registrar Sandbox Domains Read",
"zone-custom-asset.read": "Zone Custom Asset Read",
"zone-custom-asset.write": "Zone Custom Asset Write",
"zone-dns-settings.read": "Zone DNS Settings Read",
"zone-dns-settings.write": "Zone DNS Settings Write",
"zone.read": "Zone Read",
"zone-settings.read": "Zone Settings Read",
"zone-settings.write": "Zone Settings Write",
"zone-versioning.read": "Zone Versioning Read",
"zone-versioning.write": "Zone Versioning Write",
"zone.write": "Zone Write",
"fraud-detection-pii.read": "Account Abuse Protection PII Read",
"account-firewall-access-rules.read": "Account Firewall Access Rules Read",
"account-firewall-access-rules.write": "Account Firewall Access Rules Write",
"account-security-center-insights.read": "Account Security Center Insights Read",
"account-security-center-insights.write": "Account Security Center Insights Write",
"account-waf.read": "Account WAF Read",
"account-waf.write": "Account WAF Write",
"request-tracer.read": "Allow Request Tracer Read",
"reports-application-security-report.read": "Application Security Reports Read",
"bot-management-feedback.read": "Bot Management Feedback Report Read",
"bot-management-feedback.write": "Bot Management Feedback Report Write",
"bot-management.read": "Bot Management Read",
"bot-management.write": "Bot Management Write",
"cloudforce-one.read": "Cloudforce One Read",
"cloudforce-one.write": "Cloudforce One Write",
"ddos-botnet-feed.read": "DDoS Botnet Feed Read",
"ddos-botnet-feed.write": "DDoS Botnet Feed Write",
"ddos-protection.read": "DDoS Protection Read",
"ddos-protection.write": "DDoS Protection Write",
"api-gateway.write": "Domain API Gateway",
"api-gateway.read": "Domain API Gateway Read",
"domain-page.shield": "Domain Page Shield",
"domain-page-shield.read": "Domain Page Shield Read",
"field-extractor.read": "Field Extractors Read",
"field-extractor.write": "Field Extractors Write",
"firewall-services.read": "Firewall Services Read",
"firewall-services.write": "Firewall Services Write",
"fraud-detection.read": "Fraud Detection Read",
"fraud-detection.write": "Fraud Detection Write",
"fraud-events.write": "Fraud Events Write",
"fraud-feedback.read": "Fraud Feedback Read",
"fraud-feedback.write": "Fraud Feedback Write",
"http-applications.read": "HTTP Applications Read",
"http-applications.write": "HTTP Applications Write",
"http-ddos-managed-ruleset.read": "HTTP DDoS Managed Ruleset Read",
"http-ddos-managed-ruleset.write": "HTTP DDoS Managed Ruleset Write",
"iot.read": "IOT Read",
"iot.write": "IOT Write",
"l4-ddos-managed-ruleset.read": "L4 DDoS Managed Ruleset Read",
"l4-ddos-managed-ruleset.write": "L4 DDoS Managed Ruleset Write",
"page-rules.read": "Page Rules Read",
"page-rules.write": "Page Rules Write",
"page.shield": "Page Shield",
"page-shield.read": "Page Shield Read",
"precursor.read": "Precursor Read",
"precursor.write": "Precursor Write",
"sanitize.read": "Sanitize Read",
"sanitize.write": "Sanitize Write",
"tag.read": "Tag Read",
"tag.write": "Tag Write",
"trust-and-safety.read": "Trust and Safety Read",
"trust-and-safety.write": "Trust and Safety Write",
"challenge-widgets.read": "Turnstile Sites Read",
"challenge-widgets.write": "Turnstile Sites Write",
"url-scanner.read": "URL Scanner Read",
"url-scanner.write": "URL Scanner Write",
"zaraz.write": "Zaraz Admin",
"zaraz.edit": "Zaraz Edit",
"zaraz.read": "Zaraz Read",
"zone-security-center-insights.read": "Zone Security Center Insights Read",
"zone-security-center-insights.write": "Zone Security Center Insights Write",
"zone-waf.read": "Zone WAF Read",
"zone-waf.write": "Zone WAF Write",
"account-custom-error-rules.read": "Account Custom Error Rules Read",
"account-custom-error-rules.write": "Account Custom Error Rules Write",
"account-custom-pages.read": "Account Custom Pages Read",
"account-custom-pages.write": "Account Custom Pages Write",
"account-rule-lists.read": "Account Rule Lists Read",
"account-rule-lists.write": "Account Rule Lists Write",
"account-rulesets.read": "Account Rulesets Read",
"account-rulesets.write": "Account Rulesets Write",
"config-settings.read": "Config Settings Read",
"config-settings.write": "Config Settings Write",
"custom-errors.read": "Custom Errors Read",
"custom-errors.write": "Custom Errors Write",
"custom-pages.read": "Custom Pages Read",
"custom-pages.write": "Custom Pages Write",
"dynamic-redirect.read": "Dynamic URL Redirects Read",
"dynamic-redirect.write": "Dynamic URL Redirects Write",
"managed-headers.read": "Managed headers Read",
"managed-headers.write": "Managed headers Write",
"mass-url-redirects.read": "Mass URL Redirects Read",
"mass-url-redirects.write": "Mass URL Redirects Write",
"origin.read": "Origin Read",
"origin.write": "Origin Write",
"payments-gateway.read": "Payments Gateway Read",
"payments-gateway.write": "Payments Gateway Write",
"response-compression.read": "Response Compression Read",
"response-compression.write": "Response Compression Write",
"select-configuration.read": "Select Configuration Read",
"select-configuration.write": "Select Configuration Write",
"snippets.read": "Snippets Read",
"snippets.write": "Snippets Write",
"transform-rules.read": "Transform Rules Read",
"transform-rules.write": "Transform Rules Write",
"zone-transform-rules.read": "Zone Transform Rules Read",
"zone-transform-rules.write": "Zone Transform Rules Write",
"access.read": "Access: Apps and Policies Read",
"zone-access.read": "Access: Apps and Policies Read",
"access.revoke": "Access: Apps and Policies Revoke",
"zone-access.revoke": "Access: Apps and Policies Revoke",
"access.write": "Access: Apps and Policies Write",
"zone-access.write": "Access: Apps and Policies Write",
"access-app.read": "Access: Apps Read",
"access-app.revoke": "Access: Apps Revoke",
"access-app.write": "Access: Apps Write",
"access-audit-log.read": "Access: Audit Logs Read",
"access-custom-page.read": "Access: Custom Pages Read",
"access-custom-page.write": "Access: Custom Pages Write",
"access-device-posture.read": "Access: Device Posture Read",
"access-device-posture.write": "Access: Device Posture Write",
"access-group.read": "Access: Groups Read",
"access-group.write": "Access: Groups Write",
"access-idp.read": "Access: Identity Providers Read",
"access-idp.write": "Access: Identity Providers Write",
"access-key.read": "Access: Keys Read",
"access-key.write": "Access: Keys Write",
"access-certificate.read": "Access: Mutual TLS Certificates Read",
"access-certificate.write": "Access: Mutual TLS Certificates Write",
"access-org.read": "Access: Organizations Read",
"access-org.revoke": "Access: Organizations Revoke",
"access-org.write": "Access: Organizations Write",
"access-acct.read": "Access: Organizations, Identity Providers, and Groups Read",
"access-acct.revoke": "Access: Organizations, Identity Providers, and Groups Revoke",
"access-acct.write": "Access: Organizations, Identity Providers, and Groups Write",
"access-policy.read": "Access: Policies Read",
"access-policy.write": "Access: Policies Write",
"access-policy-test.read": "Access: Policy Test Read",
"access-policy-test.write": "Access: Policy Test Write",
"access-saml-certificate.read": "Access: SAML Certificates Read",
"access-saml-certificate.write": "Access: SAML Certificates Write",
"access-scim-log.read": "Access: SCIM Logs Read",
"access-population.read": "Access: SCIM Population Read",
"access-population.write": "Access: SCIM Population Write",
"access-service-token.read": "Access: Service Tokens Read",
"access-service-token.write": "Access: Service Tokens Write",
"access-ssh-auditing.read": "Access: SSH Auditing Read",
"access-ssh-auditing.write": "Access: SSH Auditing Write",
"access-tag.read": "Access: Tags Read",
"access-tag.write": "Access: Tags Write",
"access-users.read": "Access: Users Read",
"access-users.write": "Access: Users Write",
"casb.read": "CASB Read",
"casb.write": "CASB Write",
"teams-cds-compute-account.read": "Cloudflare CDS Compute Account Read",
"teams-cds-compute-account.write": "Cloudflare CDS Compute Account Write",
"teams-dex.read": "Cloudflare DEX Read",
"teams-dex.write": "Cloudflare DEX Write",
"teams-connector-cloudflared.monitoring": "Cloudflare One Connector Monitoring: cloudflared",
"teams-connector-cloudflared.read": "Cloudflare One Connector: cloudflared Read",
"teams-connector-cloudflared.write": "Cloudflare One Connector: cloudflared Write",
"teams-connector-warp.read": "Cloudflare One Connector: WARP Read",
"teams-connector-warp.write": "Cloudflare One Connector: WARP Write",
"teams-connectors.read": "Cloudflare One Connectors Read",
"teams-connectors.write": "Cloudflare One Connectors Write",
"teams-networks.read": "Cloudflare One Networks Read",
"teams-networks.write": "Cloudflare One Networks Write",
"argotunnel.read": "Cloudflare Tunnel Read",
"argotunnel.write": "Cloudflare Tunnel Write",
"teams-secure.location": "Cloudflare Zero Trust Secure DNS Locations Write",
"dls.read": "DLS: Read",
"dls.write": "DLS: Write",
"teams.read": "Zero Trust Read",
"teams.report": "Zero Trust Report",
"teams-resilience.read": "Zero Trust Resilience Read",
"teams-resilience.write": "Zero Trust Resilience Write",
"teams.write": "Zero Trust Write",
"teams-pii.read": "Zero Trust: PII Read",
"access-seats.write": "Zero Trust: Seats Write",
"account-analytics.read": "Account Analytics Read",
"analytics.read": "Analytics Read",
"intel.read": "Intel Read",
"intel.write": "Intel Write",
"account-logs.read": "Logs Read",
"logs.read": "Logs Read",
"account-logs.write": "Logs Write",
"logs.write": "Logs Write",
"radar.read": "Radar Read",
"zone-observability.read": "Zone Observability Read",
"zone-observability.write": "Zone Observability Write",
"account-waiting-rooms.read": "Account Waiting Rooms Read",
"address-maps.read": "Address Maps Read",
"address-maps.write": "Address Maps Write",
"chinanetwork-steering.read": "China Network Steering Read",
"chinanetwork-steering.write": "China Network Steering Write",
"connectivity-directory.admin": "Connectivity Directory Admin",
"connectivity-directory.bind": "Connectivity Directory Bind",
"connectivity-directory.read": "Connectivity Directory Read",
"healthcheck.read": "Health Checks Read",
"healthcheck.write": "Health Checks Write",
"ip-prefix-bgp-on-demand.read": "IP Prefixes: BGP On Demand Read",
"ip-prefix-bgp-on-demand.write": "IP Prefixes: BGP On Demand Write",
"ip-prefix.read": "IP Prefixes: Read",
"ip-prefix.write": "IP Prefixes: Write",
"load-balancers-account.read": "Load Balancers Account Read",
"load-balancers-account.write": "Load Balancers Account Write",
"load-balancers.read": "Load Balancers Read",
"load-balancers.write": "Load Balancers Write",
"load-balancing-monitors-and-pools.read": "Load Balancing: Monitors and Pools Read",
"load-balancing-monitors-and-pools.write": "Load Balancing: Monitors and Pools Write",
"pcaps-api.read": "Magic Firewall Packet Captures - Read PCAPs API",
"pcaps-api.write": "Magic Firewall Packet Captures - Write PCAPs API",
"magic-firewall.read": "Magic Firewall Read",
"magic-firewall.write": "Magic Firewall Write",
"fbm.admin": "Magic Network Monitoring Admin",
"fbm.read": "Magic Network Monitoring Config Read",
"fbm.write": "Magic Network Monitoring Config Write",
"magic-transit.read": "Magic Transit Read",
"magic-transit.write": "Magic Transit Write",
"magic-wan.read": "Magic WAN Read",
"magic-wan.write": "Magic WAN Write",
"waiting-rooms.read": "Waiting Rooms Read",
"waiting-rooms.write": "Waiting Rooms Write",
"web3-hostnames.read": "Web3 Hostnames Read",
"web3-hostnames.write": "Web3 Hostnames Write",
"calls.read": "Calls Read",
"calls.write": "Calls Write",
"images.read": "Images Read",
"images.write": "Images Write",
"moq.read": "MoQ Read",
"moq.write": "MoQ Write",
"stream.read": "Stream Read",
"stream.write": "Stream Write",
"cloud-email-security.read": "Cloud Email Security: Read",
"cloud-email-security.write": "Cloud Email Security: Write",
"email-routing-account-rule.read": "Email Routing Account Rules Read",
"email-routing-address.read": "Email Routing Addresses Read",
"email-routing-address.write": "Email Routing Addresses Write",
"email-routing-rule.read": "Email Routing Rules Read",
"email-routing-rule.write": "Email Routing Rules Write",
"email-routing-suppression.read": "Email Routing Suppressions Read",
"email-routing-suppression.write": "Email Routing Suppressions Write",
"email-security-dmarcreports.read": "Email Security DMARC Reports Read",
"email-security-dmarcreports.write": "Email Security DMARC Reports Write",
"email-sending.read": "Email Sending Read",
"email-sending.write": "Email Sending Write",
"account-ssl-and-certificates.read": "Account: SSL and Certificates Read",
"account-ssl-and-certificates.write": "Account: SSL and Certificates Write",
"cache.purge": "Cache Purge",
"cache-settings.read": "Cache Settings Read",
"cache-settings.write": "Cache Settings Write",
"account-disable-esc.read": "Disable ESC Read",
"zone-disable-esc.read": "Disable ESC Read",
"account-disable-esc.write": "Disable ESC Write",
"zone-disable-esc.write": "Disable ESC Write",
"ssl-and-certificates.read": "SSL and Certificates Read",
"ssl-and-certificates.write": "SSL and Certificates Write",
"account-api-gateway.write": "Account API Gateway",
"account-api-gateway.read": "Account API Gateway Read",
"account-custom-asset.read": "Account Custom Asset Read",
"account-custom-asset.write": "Account Custom Asset Write",
"account_api_tokens:create": "Account API Token Provisioning",
"account-settings.read": "Account Settings Read",
"account-settings.write": "Account Settings Write",
"apps.write": "Apps Write",
"integration.write": "Integration Write",
"memberships.read": "Memberships Read",
"memberships.write": "Memberships Write",
"notifications.read": "Notifications Read",
"notifications.write": "Notifications Write",
"user-details.read": "User Details Read",
"user-details.write": "User Details Write",
"artifacts.read": "Artifacts Read",
"artifacts.write": "Artifacts Write",
"resource-library.read": "Resource Library Read",
"resource-library.write": "Resource Library Write",
"resource-sharing.read": "Resource Sharing Read",
"ai-search.metadata_read": "AI Search Metadata Read",
"aig.metadata_read": "AI Gateway Metadata Read",
"d1.metadata_read": "D1 Metadata Read",
"images.metadata_read": "Images Metadata Read",
"messaging.metadata_read": "Messaging Metadata Read",
"pages.metadata_read": "Pages Metadata Read",
"queues.metadata_read": "Queues Metadata Read",
"stream.metadata_read": "Stream Metadata Read",
"websearch.metadata_read": "Websearch Metadata Read",
"workers-kv-storage.metadata_read": "Workers KV Storage Metadata Read",
"workers-r2.metadata_read": "Workers R2 Storage Metadata Read",
"workers-scripts.bind": "Workers Scripts Bind",
"workers_ai.metadata_read": "Workers AI Metadata Read",
};
/** Flat lookup retained for consumers that do not need grouping metadata. */
export const ALL_SCOPES = Object.fromEntries(
OAUTH_SCOPE_GROUPS.flatMap((group) => group.scopes.map((scope) => [scope, group.label])),
) as Readonly<Record<OAuthScopeId, string>>;
/** Every scope available to the `cf` CLI OAuth client. */
export const ALL_SCOPE_IDS: ReadonlyArray<OAuthScopeId> = OAUTH_SCOPE_GROUPS.flatMap(
(group) => group.scopes,
);
/**
* The OAuth scope that grants a refresh token. Every authorization requests
* it, and the token response echoes it into the stored scopes, so it is
* never a catalog scope.
*/
export const OFFLINE_ACCESS_SCOPE = "offline_access";
/**
* Split stored scopes into those the current OAuth client offers and those
* it does not, leaving out {@link OFFLINE_ACCESS_SCOPE}. Profiles configured
* against an older client (or scope catalog) can hold scopes the current
* client rejects, and a single unknown scope invalidates the entire
* authorize URL — sanitize with this before building one.
*/
export const partitionOAuthScopes = (
scopes: ReadonlyArray<string>,
): { valid: string[]; dropped: string[] } => {
const known = new Set<string>(ALL_SCOPE_IDS);
const catalog = scopes.filter((scope) => scope !== OFFLINE_ACCESS_SCOPE);
return {
valid: catalog.filter((scope) => known.has(scope)),
dropped: catalog.filter((scope) => !known.has(scope)),
};
};
/**
* Initial selections for the custom-scope prompt. Reconfiguration restores
* the existing OAuth grant while dropping scopes no longer offered by the
* current client; first-time and stored-credential setup select every scope.
*/
export const customOAuthScopeDefaults = (currentConfig?: {
readonly method: string;
readonly scopes?: ReadonlyArray<string>;
readonly [key: string]: unknown;
}): string[] =>
currentConfig?.method === "oauth" && currentConfig.scopes !== undefined
? partitionOAuthScopes(currentConfig.scopes).valid
: [...ALL_SCOPE_IDS];
/** Reusable scope bundles for common OAuth authorization flows. */
export const OAUTH_SCOPE_TEMPLATES = {
basic: [
"memberships.read",
"user-details.read",
"account-settings.read",
"ai-search.run",
"ai-search.write",
"ai.write",
"aig.read",
"aig.run",
"aig.write",
"connectivity-directory.admin",
"account-ssl-and-certificates.write",
"ssl-and-certificates.write",
"zone.read",
// every Developer Platform scope
...OAUTH_SCOPE_GROUPS[0].scopes,
],
} as const satisfies Readonly<Record<string, ReadonlyArray<OAuthScopeId>>>;
export const BASIC_SCOPES: ReadonlyArray<OAuthScopeId> = OAUTH_SCOPE_TEMPLATES.basic;