OAuth access scopes

The full list of OAuth application access scopes.

See the OAuth documentation for more information on creating OAuth applications on PlanetScale.

User access

Access permissionsDescription
read_userRead user
write_userWrite user
read_organizationsRead a user's organizations

Organization access

Access permissionsDescription
write_organizationWrite organization
read_organizationRead organization
read_invoicesRead organization invoices
delete_organizationDelete organization
read_databasesRead organization databases
create_databasesCreate organization databases
write_databasesWrite organization databases
delete_databasesDelete organization databases
write_membersWrite members
read_membersRead members
delete_membersDelete members
read_branchesRead database branches
write_branchesWrite database branches
delete_branchesDelete database branches
promote_branchesPromote database branches
delete_production_branchesDelete a production database branch
manage_production_branch_passwordsRead, write, and delete production branch passwords
write_deploy_requestsCreate and update deploy requests in a database
read_deploy_requestsRead deploy requests in a database
deploy_deploy_requestsDeploy deploy requests in a database
approve_deploy_requestsApprove deploy requests in a database
write_commentsCreate deploy request comments in a database
read_commentsRead deploy request comments in a database
manage_passwordsRead, write, and delete branch passwords
write_backupsCreate and update backups
read_backupsRead backups
delete_backupsDelete backups
delete_production_branch_backupsDelete production backups
restore_backupsRestore this branch's backups to new branches
restore_production_branch_backupsRestore production branch backups to new

Database access

Access permissionsDescription
write_membersWrite members
read_membersRead members
delete_membersDelete members
read_branchesRead database branches
write_branchesWrite database branches
delete_branchesDelete database branches
promote_branchesPromote database branches
delete_production_branchesDelete a production database branch
manage_production_branch_passwordsRead, write, and delete production branch passwords
write_deploy requestsCreate and update deploy requests in a database
read_deploy_requestsRead deploy requests in a database
deploy_deploy_requestsDeploy deploy requests in a database
approve_deploy_requestsApprove deploy requests in a database
write_commentsCreate deploy request comments in a database
read_commentsRead deploy request comments in a database
read_databaseRead database information
delete_databaseDelete a database
write_databaseWrite database
manage_passwordsRead, write, and delete branch passwords
write_backupsCreate and update backups
read_backupsRead backups
delete_backupsDelete backups
delete_production_branch_backupsDelete production backups
restore_backupsRestore this branch's backups to new branches
restore_production_branch_backupsRestore production branch backups to new branches

Branch access

Access permissionsDescription
manage_passwordsRead, write, and delete branch passwords
write_branchWrite a database branch
read_branchRead a database branch
delete_branchDelete a database branch
write_backupsCreate and update backups
read_backupsRead backups
delete_backupsDelete backups
restore_backupsRestore this branch's backups to new branches