Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

18.9 KB
Raw Blame
// Generated by `pnpm --filter=api-types codegen:prod` from the production OpenAPI specifications. Do not edit by hand.
// Maps each endpoint annotated with `x-fga-permissions` to the FGA permissions it requires. A caller
// needs every permission in at least one group (OR between groups, AND within a group). Keys are the
// path literals passed to openapi-fetch.

export const fgaRequirements = {
  'DELETE /platform/organizations/{slug}/apps/installations/{installation_id}': [
    ['organization_admin_write'],
  ],
  'DELETE /platform/organizations/{slug}/apps/{app_id}': [['organization_admin_write']],
  'DELETE /platform/organizations/{slug}/apps/{app_id}/signing-keys/{key_id}': [
    ['organization_admin_write'],
  ],
  'DELETE /platform/organizations/{slug}/members/invitations/{id}': [['members_write']],
  'DELETE /v1/branches/{branch_id_or_ref}': [
    ['branching_development_delete'],
    ['branching_production_delete'],
  ],
  'DELETE /v1/projects/{ref}': [['project_admin_write']],
  'DELETE /v1/projects/{ref}/api-keys/{id}': [['api_gateway_keys_write']],
  'DELETE /v1/projects/{ref}/billing/addons/{addon_variant}': [['infra_add_ons_write']],
  'DELETE /v1/projects/{ref}/branches': [['branching_production_delete']],
  'DELETE /v1/projects/{ref}/claim-token': [['organization_admin_write', 'project_admin_write']],
  'DELETE /v1/projects/{ref}/cli/login-role': [['database_write']],
  'DELETE /v1/projects/{ref}/config/auth/signing-keys/{id}': [['auth_signing_keys_write']],
  'DELETE /v1/projects/{ref}/config/auth/sso/providers/{provider_id}': [['auth_config_write']],
  'DELETE /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}': [['auth_config_write']],
  'DELETE /v1/projects/{ref}/custom-hostname': [['custom_domain_write']],
  'DELETE /v1/projects/{ref}/database/jit/invite/{invite_id}': [['database_jit_write']],
  'DELETE /v1/projects/{ref}/database/jit/{user_id}': [['database_jit_write']],
  'DELETE /v1/projects/{ref}/database/migrations': [['database_migrations_write']],
  'DELETE /v1/projects/{ref}/functions/{function_slug}': [['edge_functions_write']],
  'DELETE /v1/projects/{ref}/network-bans': [['database_network_bans_write']],
  'DELETE /v1/projects/{ref}/secrets': [['edge_functions_secrets_write']],
  'DELETE /v1/projects/{ref}/vanity-subdomain': [['vanity_subdomain_write']],
  'DELETE /v2/organizations/{slug}/members/invitations': [['members_write']],
  'DELETE /v2/projects/{ref}/analytics/log-drains/{id}': [['analytics_config_write']],
  'DELETE /v2/projects/{ref}/compute/{name}': [['workers_write']],
  'DELETE /v2/projects/{ref}/notebooks/{id}': [['project_notebooks_write']],
  'DELETE /v2/projects/{ref}/private-link/associations/aws-account/{aws_account_id}': [
    ['project_admin_write'],
  ],
  'DELETE /v2/projects/{ref}/private-link/associations/aws-account/{aws_account_id}/database/{database_identifier}':
    [['project_admin_write']],
  'GET /platform/database/{ref}/backups': [['backups_read']],
  'GET /platform/database/{ref}/backups/downloadable-backups': [['backups_read']],
  'GET /platform/oauth/authorizations/{id}': [['organization_admin_read']],
  'GET /platform/organizations/{slug}/apps': [['organization_admin_read']],
  'GET /platform/organizations/{slug}/apps/installations': [['organization_admin_read']],
  'GET /platform/organizations/{slug}/apps/installations/{installation_id}': [
    ['organization_admin_read'],
  ],
  'GET /platform/organizations/{slug}/apps/{app_id}': [['organization_admin_read']],
  'GET /platform/organizations/{slug}/apps/{app_id}/signing-keys': [['organization_admin_read']],
  'GET /platform/organizations/{slug}/billing/credits/burndown': [['organization_admin_read']],
  'GET /platform/organizations/{slug}/members/invitations': [['members_read']],
  'GET /platform/storage/{ref}/archive': [['storage_write']],
  'GET /v1/branches/{branch_id_or_ref}': [
    ['branching_development_read'],
    ['branching_production_read'],
  ],
  'GET /v1/branches/{branch_id_or_ref}/diff': [
    ['branching_development_write'],
    ['branching_production_write'],
  ],
  'GET /v1/oauth/authorize/project-claim': [['organization_admin_write', 'project_admin_write']],
  'GET /v1/organizations': [['organizations_read']],
  'GET /v1/organizations/{slug}': [['organization_admin_read']],
  'GET /v1/organizations/{slug}/entitlements': [['organization_admin_read']],
  'GET /v1/organizations/{slug}/members': [['members_read']],
  'GET /v1/organizations/{slug}/project-claim/{token}': [['organization_admin_write']],
  'GET /v1/organizations/{slug}/projects': [['organization_projects_read']],
  'GET /v1/projects': [['projects_read']],
  'GET /v1/projects/{ref}': [['project_admin_read']],
  'GET /v1/projects/{ref}/actions': [['action_runs_read']],
  'GET /v1/projects/{ref}/actions/{run_id}': [['action_runs_read']],
  'GET /v1/projects/{ref}/actions/{run_id}/logs': [['action_runs_read']],
  'GET /v1/projects/{ref}/advisors/performance': [['advisors_read']],
  'GET /v1/projects/{ref}/advisors/security': [['advisors_read']],
  'GET /v1/projects/{ref}/analytics/endpoints/functions.combined-stats': [['analytics_usage_read']],
  'GET /v1/projects/{ref}/analytics/endpoints/logs': [['analytics_logs_read']],
  'GET /v1/projects/{ref}/analytics/endpoints/logs.all': [['analytics_logs_read']],
  'GET /v1/projects/{ref}/analytics/endpoints/metrics': [['analytics_logs_read']],
  'GET /v1/projects/{ref}/analytics/endpoints/usage.api-counts': [['analytics_usage_read']],
  'GET /v1/projects/{ref}/analytics/endpoints/usage.api-requests-count': [['analytics_usage_read']],
  'GET /v1/projects/{ref}/api-keys': [
    ['api_gateway_keys_read'],
    ['api_gateway_keys_read', 'api_gateway_keys_secret_read'],
  ],
  'GET /v1/projects/{ref}/api-keys/legacy': [['api_gateway_keys_read']],
  'GET /v1/projects/{ref}/api-keys/{id}': [
    ['api_gateway_keys_read'],
    ['api_gateway_keys_read', 'api_gateway_keys_secret_read'],
  ],
  'GET /v1/projects/{ref}/billing/addons': [['infra_add_ons_read']],
  'GET /v1/projects/{ref}/branches': [
    ['branching_development_read'],
    ['branching_production_read'],
  ],
  'GET /v1/projects/{ref}/branches/{name}': [
    ['branching_development_read'],
    ['branching_production_read'],
  ],
  'GET /v1/projects/{ref}/claim-token': [['project_admin_read']],
  'GET /v1/projects/{ref}/config/auth': [['auth_config_read']],
  'GET /v1/projects/{ref}/config/auth/signing-keys': [['auth_signing_keys_read']],
  'GET /v1/projects/{ref}/config/auth/signing-keys/legacy': [['auth_signing_keys_read']],
  'GET /v1/projects/{ref}/config/auth/signing-keys/{id}': [['auth_signing_keys_read']],
  'GET /v1/projects/{ref}/config/auth/sso/providers': [['auth_config_read']],
  'GET /v1/projects/{ref}/config/auth/sso/providers/{provider_id}': [['auth_config_read']],
  'GET /v1/projects/{ref}/config/auth/third-party-auth': [['auth_config_read']],
  'GET /v1/projects/{ref}/config/auth/third-party-auth/{tpa_id}': [['auth_config_read']],
  'GET /v1/projects/{ref}/config/database/pgbouncer': [['database_read']],
  'GET /v1/projects/{ref}/config/database/pooler': [['database_pooling_config_read']],
  'GET /v1/projects/{ref}/config/database/postgres': [['database_config_read']],
  'GET /v1/projects/{ref}/config/disk': [['infra_disk_config_read']],
  'GET /v1/projects/{ref}/config/disk/autoscale': [['infra_disk_config_read']],
  'GET /v1/projects/{ref}/config/disk/util': [['infra_disk_config_read']],
  'GET /v1/projects/{ref}/config/realtime': [['realtime_config_read']],
  'GET /v1/projects/{ref}/config/storage': [['storage_config_read']],
  'GET /v1/projects/{ref}/custom-hostname': [['custom_domain_read']],
  'GET /v1/projects/{ref}/database/backups': [['backups_read']],
  'GET /v1/projects/{ref}/database/backups/restore-point': [['backups_read']],
  'GET /v1/projects/{ref}/database/backups/schedule': [['backups_read']],
  'GET /v1/projects/{ref}/database/context': [['database_read']],
  'GET /v1/projects/{ref}/database/jit': [['database_jit_read']],
  'GET /v1/projects/{ref}/database/jit/list': [['database_jit_write']],
  'GET /v1/projects/{ref}/database/migrations': [['database_migrations_read']],
  'GET /v1/projects/{ref}/database/migrations/{version}': [['database_migrations_read']],
  'GET /v1/projects/{ref}/database/openapi': [['database_read']],
  'GET /v1/projects/{ref}/functions': [['edge_functions_read']],
  'GET /v1/projects/{ref}/functions/{function_slug}': [['edge_functions_read']],
  'GET /v1/projects/{ref}/functions/{function_slug}/body': [['edge_functions_read']],
  'GET /v1/projects/{ref}/health': [['project_admin_read']],
  'GET /v1/projects/{ref}/jit-access': [['project_admin_read']],
  'GET /v1/projects/{ref}/network-restrictions': [['database_network_restrictions_read']],
  'GET /v1/projects/{ref}/pgsodium': [['project_admin_write']],
  'GET /v1/projects/{ref}/postgrest': [
    ['data_api_config_read'],
    ['data_api_config_read', 'data_api_config_secret_read'],
  ],
  'GET /v1/projects/{ref}/readonly': [['database_readonly_config_read']],
  'GET /v1/projects/{ref}/restore': [['project_admin_read']],
  'GET /v1/projects/{ref}/secrets': [['edge_functions_secrets_read']],
  'GET /v1/projects/{ref}/ssl-enforcement': [['database_ssl_config_read']],
  'GET /v1/projects/{ref}/storage/buckets': [['storage_read']],
  'GET /v1/projects/{ref}/types/typescript': [['database_read']],
  'GET /v1/projects/{ref}/upgrade/eligibility': [['project_admin_read', 'database_read']],
  'GET /v1/projects/{ref}/upgrade/status': [['project_admin_read', 'database_read']],
  'GET /v1/projects/{ref}/vanity-subdomain': [['vanity_subdomain_read']],
  'GET /v1/snippets': [['snippets_read']],
  'GET /v1/snippets/{id}': [['snippets_read']],
  'GET /v2/organizations/{slug}/integrations/github/connections': [['organization_projects_read']],
  'GET /v2/organizations/{slug}/members': [['members_read']],
  'GET /v2/organizations/{slug}/projects': [['organization_projects_read']],
  'GET /v2/organizations/{slug}/roles': [['members_read']],
  'GET /v2/projects/{ref}/analytics/log-drains': [['analytics_config_read']],
  'GET /v2/projects/{ref}/compute': [['workers_read']],
  'GET /v2/projects/{ref}/compute/{name}': [['workers_read']],
  'GET /v2/projects/{ref}/config': [
    [
      'database_config_read',
      'database_read',
      'database_ssl_config_read',
      'database_network_restrictions_read',
      'auth_config_read',
      'data_api_config_read',
      'realtime_config_read',
      'storage_config_read',
    ],
  ],
  'GET /v2/projects/{ref}/notebooks': [['project_notebooks_read']],
  'GET /v2/projects/{ref}/notebooks/{id}': [['project_notebooks_read']],
  'GET /v2/projects/{ref}/private-link/associations': [['project_admin_read']],
  'HEAD /v1/projects/{ref}/actions': [['action_runs_read']],
  'PATCH /platform/feedback/conversations/{conversation_id}/custom-fields': [['database_read']],
  'PATCH /platform/organizations/{slug}/apps/installations/{installation_id}': [
    ['organization_admin_write'],
  ],
  'PATCH /platform/organizations/{slug}/apps/{app_id}': [['organization_admin_write']],
  'PATCH /v1/branches/{branch_id_or_ref}': [
    ['branching_development_write'],
    ['branching_production_write'],
  ],
  'PATCH /v1/projects/{ref}': [['project_admin_write']],
  'PATCH /v1/projects/{ref}/actions/{run_id}/status': [['action_runs_write']],
  'PATCH /v1/projects/{ref}/api-keys/{id}': [['api_gateway_keys_write']],
  'PATCH /v1/projects/{ref}/billing/addons': [['infra_add_ons_write']],
  'PATCH /v1/projects/{ref}/config/auth': [['auth_config_write', 'project_admin_write']],
  'PATCH /v1/projects/{ref}/config/auth/signing-keys/{id}': [['auth_signing_keys_write']],
  'PATCH /v1/projects/{ref}/config/database/pooler': [['database_pooling_config_write']],
  'PATCH /v1/projects/{ref}/config/realtime': [['realtime_config_write']],
  'PATCH /v1/projects/{ref}/config/storage': [['storage_config_write']],
  'PATCH /v1/projects/{ref}/database/backups/schedule': [['backups_write']],
  'PATCH /v1/projects/{ref}/database/migrations/{version}': [['database_migrations_write']],
  'PATCH /v1/projects/{ref}/database/password': [['database_config_write']],
  'PATCH /v1/projects/{ref}/functions/{function_slug}': [['edge_functions_write']],
  'PATCH /v1/projects/{ref}/network-restrictions': [['database_network_restrictions_write']],
  'PATCH /v1/projects/{ref}/postgrest': [['data_api_config_write']],
  'PATCH /v2/organizations/{slug}/members/{user_id}/roles': [['organization_admin_write']],
  'PATCH /v2/projects/{ref}/notebooks/{id}': [['project_notebooks_write']],
  'POST /platform/database/{ref}/backups/download': [['backups_write']],
  'POST /platform/database/{ref}/backups/pitr': [['backups_write']],
  'POST /platform/database/{ref}/backups/restore': [['backups_write']],
  'POST /platform/database/{ref}/backups/restore-physical': [['backups_write']],
  'POST /platform/feedback/send': [['organization_admin_read'], ['project_admin_read']],
  'POST /platform/organizations/{slug}/apps': [['organization_admin_write']],
  'POST /platform/organizations/{slug}/apps/installations': [['organization_admin_write']],
  'POST /platform/organizations/{slug}/apps/{app_id}/signing-keys': [['organization_admin_write']],
  'POST /platform/organizations/{slug}/members/invitations': [['members_write']],
  'POST /platform/pg-meta/{ref}/query': [['database_read']],
  'POST /platform/projects/{ref}/api/graphql': [['database_read'], ['database_write']],
  'POST /platform/projects/{ref}/resize': [['project_admin_write']],
  'POST /platform/projects/{ref}/restart': [['database_write']],
  'POST /platform/projects/{ref}/restart-services': [['database_write']],
  'POST /platform/projects/{ref}/wake': [['project_admin_read']],
  'POST /platform/storage/{ref}/archive': [['storage_write']],
  'POST /v1/branches/{branch_id_or_ref}/merge': [
    ['branching_development_write'],
    ['branching_production_write'],
  ],
  'POST /v1/branches/{branch_id_or_ref}/push': [
    ['branching_development_write'],
    ['branching_production_write'],
  ],
  'POST /v1/branches/{branch_id_or_ref}/reset': [
    ['branching_development_write'],
    ['branching_production_write'],
  ],
  'POST /v1/branches/{branch_id_or_ref}/restore': [
    ['branching_development_write'],
    ['branching_production_write'],
  ],
  'POST /v1/organizations': [['organizations_create']],
  'POST /v1/organizations/{slug}/project-claim/{token}': [['organization_admin_write']],
  'POST /v1/projects': [['organization_projects_create']],
  'POST /v1/projects/{ref}/api-keys': [['api_gateway_keys_write']],
  'POST /v1/projects/{ref}/branches': [
    ['branching_development_create'],
    ['branching_production_create'],
  ],
  'POST /v1/projects/{ref}/claim-token': [['organization_admin_write', 'project_admin_write']],
  'POST /v1/projects/{ref}/cli/login-role': [['database_write']],
  'POST /v1/projects/{ref}/config/auth/signing-keys': [['auth_signing_keys_write']],
  'POST /v1/projects/{ref}/config/auth/signing-keys/legacy': [['auth_signing_keys_write']],
  'POST /v1/projects/{ref}/config/auth/sso/providers': [['auth_config_write']],
  'POST /v1/projects/{ref}/config/auth/third-party-auth': [['auth_config_write']],
  'POST /v1/projects/{ref}/config/disk': [['infra_disk_config_write']],
  'POST /v1/projects/{ref}/config/realtime/shutdown': [['realtime_config_write']],
  'POST /v1/projects/{ref}/custom-hostname/activate': [['custom_domain_write']],
  'POST /v1/projects/{ref}/custom-hostname/initialize': [['custom_domain_write']],
  'POST /v1/projects/{ref}/custom-hostname/reverify': [['custom_domain_write']],
  'POST /v1/projects/{ref}/database/backups/restore': [['backups_write']],
  'POST /v1/projects/{ref}/database/backups/restore-pitr': [['backups_write']],
  'POST /v1/projects/{ref}/database/backups/restore-point': [['backups_write']],
  'POST /v1/projects/{ref}/database/backups/undo': [['backups_write']],
  'POST /v1/projects/{ref}/database/jit': [['database_jit_read']],
  'POST /v1/projects/{ref}/database/jit/invite': [['database_jit_write']],
  'POST /v1/projects/{ref}/database/migrations': [['database_migrations_write']],
  'POST /v1/projects/{ref}/database/query': [['database_read'], ['database_write']],
  'POST /v1/projects/{ref}/database/query/read-only': [['database_read']],
  'POST /v1/projects/{ref}/database/webhooks/enable': [['database_webhooks_config_write']],
  'POST /v1/projects/{ref}/functions': [['edge_functions_write']],
  'POST /v1/projects/{ref}/functions/deploy': [['edge_functions_write']],
  'POST /v1/projects/{ref}/network-bans/retrieve': [['database_network_bans_read']],
  'POST /v1/projects/{ref}/network-bans/retrieve/enriched': [['database_network_bans_read']],
  'POST /v1/projects/{ref}/network-restrictions/apply': [['database_network_restrictions_write']],
  'POST /v1/projects/{ref}/pause': [['project_admin_write']],
  'POST /v1/projects/{ref}/read-replicas/remove': [['infra_read_replicas_write']],
  'POST /v1/projects/{ref}/read-replicas/setup': [['infra_read_replicas_write']],
  'POST /v1/projects/{ref}/readonly/temporary-disable': [['database_readonly_config_write']],
  'POST /v1/projects/{ref}/restart': [['project_admin_write']],
  'POST /v1/projects/{ref}/restore': [['project_admin_write']],
  'POST /v1/projects/{ref}/restore/cancel': [['project_admin_write']],
  'POST /v1/projects/{ref}/secrets': [['edge_functions_secrets_write']],
  'POST /v1/projects/{ref}/upgrade': [['project_admin_write', 'database_write']],
  'POST /v1/projects/{ref}/vanity-subdomain/activate': [['vanity_subdomain_write']],
  'POST /v1/projects/{ref}/vanity-subdomain/check-availability': [['vanity_subdomain_write']],
  'POST /v2/organizations/{slug}/members/invitations': [['members_write']],
  'POST /v2/projects/{ref}/advisors/run': [['advisors_read']],
  'POST /v2/projects/{ref}/analytics/log-drains': [['analytics_config_write']],
  'POST /v2/projects/{ref}/branches': [
    ['branching_development_create'],
    ['branching_production_create'],
  ],
  'POST /v2/projects/{ref}/compute/{name}/deploy': [['workers_write']],
  'POST /v2/projects/{ref}/compute/{name}/uploads': [['workers_write']],
  'POST /v2/projects/{ref}/notebooks': [['project_notebooks_write']],
  'POST /v2/projects/{ref}/private-link/associations': [['project_admin_write']],
  'POST /v2/projects/{ref}/transfers': [['organization_admin_write']],
  'POST /v2/projects/{ref}/transfers/previews': [['project_admin_read']],
  'PUT /v1/projects/{ref}/api-keys/legacy': [['api_gateway_keys_write']],
  'PUT /v1/projects/{ref}/config/auth/sso/providers/{provider_id}': [['auth_config_write']],
  'PUT /v1/projects/{ref}/config/database/postgres': [['database_config_write']],
  'PUT /v1/projects/{ref}/database/jit': [['database_jit_write']],
  'PUT /v1/projects/{ref}/database/migrations': [['database_migrations_write']],
  'PUT /v1/projects/{ref}/functions': [['edge_functions_write']],
  'PUT /v1/projects/{ref}/jit-access': [['project_admin_write']],
  'PUT /v1/projects/{ref}/pgsodium': [['project_admin_write']],
  'PUT /v1/projects/{ref}/ssl-enforcement': [['database_ssl_config_write']],
  'PUT /v2/projects/{ref}/analytics/log-drains/{id}': [['analytics_config_write']],
} as const

export type FgaRequirements = typeof fgaRequirements
export type FgaGuardedEndpoint = keyof FgaRequirements