Roles
List roles
Authorization
A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
Service Token Accesses read_branch, delete_branch, create_branch, connect_production_branch, connect_production_read_only_branch, connect_branch
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | manage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords |
| Database | manage_passwords, manage_production_branch_passwords, manage_read_only_passwords, manage_production_read_only_passwords |
| Branch | manage_passwords, manage_read_only_passwords |
get/organizations/{organization}/databases/{database}/branches/{branch}/roles
Path parameters
organizationstring required
Organization name slug from list_organizations. Example: acme.
databasestring required
Database name slug from list_databases. Example: app-db.
branchstring required
Branch name from list_branches. Example: main.
Query parameters
pageinteger
If provided, specifies the page offset of returned results
per_pageinteger
If provided, specifies the number of returned results
statusstring
Filter roles by status
qstring
Search roles by name or username
Response
Returns roles