References
API-to-scope reference
Required scopes for every public DevRev API endpoint, auto-generated from the OpenAPI spec.
This page is auto-generated from the public OpenAPI spec during the documentation build. Do not edit it manually — changes are overwritten on rebuild. To update scope annotations, modify the gateway proto annotations and regenerate the spec.
Each row shows the HTTP method, API path, and the scope(s) that a snap-in's service account must hold to call that endpoint. For context on how to declare scopes in your manifest, see Snap-in scopes.
Endpoints that need no scopes show None in the Required scope column.
Other
| Method | API path | Required scope |
|---|---|---|
GET | /ping | None |
POST | /ping | None |
Atoms
| Method | API path | Required scope |
|---|---|---|
GET | /atoms.get | {object_type}:read (derived from id field — for example, issue:read, ticket:read) |
POST | /atoms.get | {object_type}:read (derived from id field — for example, issue:read, ticket:read) |
Auth connections
| Method | API path | Required scope |
|---|---|---|
POST | /dev-orgs.auth-connections.create | dev_org:write |
POST | /dev-orgs.auth-connections.delete | dev_org:all |
GET | /dev-orgs.auth-connections.get | dev_org:read |
POST | /dev-orgs.auth-connections.get | dev_org:read |
GET | /dev-orgs.auth-connections.list | dev_org:read |
POST | /dev-orgs.auth-connections.list | dev_org:read |
POST | /dev-orgs.auth-connections.toggle | dev_org:write |
POST | /dev-orgs.auth-connections.update | dev_org:write |
Organizations
| Method | API path | Required scope |
|---|---|---|
GET | /dev-orgs.get | dev_org:read |
POST | /dev-orgs.get | dev_org:read |
Users
| Method | API path | Required scope |
|---|---|---|
POST | /dev-users.activate | dev_user:write |
POST | /dev-users.create | dev_user:write |
POST | /dev-users.deactivate | dev_user:all |
GET | /dev-users.get | dev_user:read |
POST | /dev-users.get | dev_user:read |
POST | /dev-users.identities.link | dev_user:write |
POST | /dev-users.identities.unlink | dev_user:write |
GET | /dev-users.list | dev_user:read |
POST | /dev-users.list | dev_user:read |
POST | /dev-users.merge | dev_user:all |
GET | /dev-users.self | None |
POST | /dev-users.self | None |
POST | /dev-users.self.update | None |
POST | /dev-users.update | dev_user:write |
Groups
| Method | API path | Required scope |
|---|---|---|
POST | /groups.create | group:write |
GET | /groups.get | group:read |
POST | /groups.get | group:read |
GET | /groups.list | group:read |
POST | /groups.list | group:read |
POST | /groups.members.add | group_membership:write |
GET | /groups.members.list | group_membership:read |
POST | /groups.members.list | group_membership:read |
POST | /groups.members.remove | group_membership:write |
POST | /groups.update | group:write |
Workspaces
| Method | API path | Required scope |
|---|---|---|
POST | /rev-orgs.create | rev_org:write |
POST | /rev-orgs.delete | rev_org:all |
GET | /rev-orgs.get | rev_org:read |
POST | /rev-orgs.get | rev_org:read |
GET | /rev-orgs.list | rev_org:read |
POST | /rev-orgs.list | rev_org:read |
POST | /rev-orgs.update | rev_org:write |
Customers
| Method | API path | Required scope |
|---|---|---|
POST | /rev-users.create | rev_user:write |
POST | /rev-users.delete | rev_user:all |
GET | /rev-users.get | rev_user:read |
POST | /rev-users.get | rev_user:read |
GET | /rev-users.list | rev_user:read |
POST | /rev-users.list | rev_user:read |
POST | /rev-users.merge | rev_user:all |
GET | /rev-users.scan | rev_user:read |
POST | /rev-users.scan | rev_user:read |
POST | /rev-users.update | rev_user:write |
System users
| Method | API path | Required scope |
|---|---|---|
GET | /sys-users.list | dev_user:read |
POST | /sys-users.list | dev_user:read |
POST | /sys-users.update | dev_user:write |
Last updated on