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

MethodAPI pathRequired scope
GET/pingNone
POST/pingNone

Accounts

MethodAPI pathRequired scope
POST/accounts.createaccount:write,account:all
POST/accounts.deleteaccount:all
GET/accounts.exportaccount:read,account:write,account:all
POST/accounts.exportaccount:read,account:write,account:all
GET/accounts.getaccount:read,account:write,account:all
POST/accounts.getaccount:read,account:write,account:all
GET/accounts.listaccount:read,account:write,account:all
POST/accounts.listaccount:read,account:write,account:all
POST/accounts.mergeaccount:all
POST/accounts.updateaccount:write,account:all

Articles

MethodAPI pathRequired scope
POST/articles.createarticle:write,article:all
POST/articles.deletearticle:all
GET/articles.getarticle:read,article:write,article:all
POST/articles.getarticle:read,article:write,article:all
GET/articles.listarticle:read,article:write,article:all
POST/articles.listarticle:read,article:write,article:all
POST/articles.updatearticle:write,article:all

Artifacts

MethodAPI pathRequired scope
GET/artifacts.downloadartifact:read
POST/artifacts.downloadartifact:read
GET/artifacts.getartifact:read — Also needs parent read access.
POST/artifacts.getartifact:read — Also needs parent read access.
GET/artifacts.listartifact:read — Also needs parent read access.
POST/artifacts.listartifact:read — Also needs parent read access.
GET/artifacts.locateartifact:read — Also needs parent read access.
POST/artifacts.locateartifact:read — Also needs parent read access.
POST/artifacts.prepareartifact:create
POST/artifacts.versions.deleteartifact:create
POST/artifacts.versions.prepareartifact:create

Atoms

MethodAPI pathRequired 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

MethodAPI pathRequired scope
POST/dev-orgs.auth-connections.createNone — Cannot be called via service account.
POST/dev-orgs.auth-connections.deleteNone — Cannot be called via service account.
GET/dev-orgs.auth-connections.getCannot be called via service account.
POST/dev-orgs.auth-connections.getCannot be called via service account.
GET/dev-orgs.auth-connections.listNone — Cannot be called via service account.
POST/dev-orgs.auth-connections.listNone — Cannot be called via service account.
POST/dev-orgs.auth-connections.toggleNone — Cannot be called via service account.
POST/dev-orgs.auth-connections.updateNone — Cannot be called via service account.

Auth tokens

MethodAPI pathRequired scope
POST/auth-tokens.createNone
POST/auth-tokens.deleteNone
GET/auth-tokens.getNone
POST/auth-tokens.getNone
GET/auth-tokens.infoNone
POST/auth-tokens.infoNone
GET/auth-tokens.listNone
POST/auth-tokens.listNone
POST/auth-tokens.self.deleteNone
POST/auth-tokens.updateNone

Chats

MethodAPI pathRequired scope
POST/chats.createNone — Access is determined by chat membership.
GET/chats.getNone — Access is determined by chat membership.
POST/chats.getNone — Access is determined by chat membership.
POST/chats.updateNone — Access is determined by chat membership.

Code changes

MethodAPI pathRequired scope
POST/code-changes.createcode_change:write,code_change:all
POST/code-changes.deletecode_change:all
GET/code-changes.getcode_change:read,code_change:write,code_change:all
POST/code-changes.getcode_change:read,code_change:write,code_change:all
GET/code-changes.listcode_change:read,code_change:write,code_change:all
POST/code-changes.listcode_change:read,code_change:write,code_change:all
POST/code-changes.updatecode_change:write,code_change:all

Commands

MethodAPI pathRequired scope
POST/commands.createcommand:write,command:all
GET/commands.getcommand:read,command:write,command:all
POST/commands.getcommand:read,command:write,command:all
GET/commands.listcommand:read,command:write,command:all
POST/commands.listcommand:read,command:write,command:all
POST/commands.updatecommand:write,command:all

Conversations

MethodAPI pathRequired scope
POST/conversations.createconversation:write,conversation:all
POST/conversations.deleteconversation:all
GET/conversations.getconversation:read,conversation:write,conversation:all
POST/conversations.getconversation:read,conversation:write,conversation:all
GET/conversations.listconversation:read,conversation:write,conversation:all
POST/conversations.listconversation:read,conversation:write,conversation:all
POST/conversations.updateconversation:write,conversation:all

Customization

MethodAPI pathRequired scope
GET/custom-objects.countNone
POST/custom-objects.countNone
POST/custom-objects.createcustom_type_fragment:write
POST/custom-objects.deletecustom_type_fragment:write
GET/custom-objects.getNone
POST/custom-objects.getNone
GET/custom-objects.listNone
POST/custom-objects.listNone
POST/custom-objects.updatecustom_type_fragment:write
GET/schemas.aggregated.getNone
POST/schemas.aggregated.getNone
GET/schemas.custom.getNone
POST/schemas.custom.getNone
GET/schemas.custom.listNone
POST/schemas.custom.listNone
POST/schemas.custom.setcustom_type_fragment:write
GET/schemas.stock.getNone
POST/schemas.stock.getNone
GET/schemas.stock.listNone
POST/schemas.stock.listNone
POST/schemas.subtypes.prepare-updatecustom_type_fragment:write
POST/stage-diagrams.createstage_diagram:write
GET/stage-diagrams.getNone
POST/stage-diagrams.getNone
GET/stage-diagrams.listNone
POST/stage-diagrams.listNone
POST/stage-diagrams.updatestage_diagram:write
POST/stages.custom.createcustom_stage:write
GET/stages.custom.getNone
POST/stages.custom.getNone
GET/stages.custom.listNone
POST/stages.custom.listNone
POST/stages.custom.updatecustom_stage:write
POST/states.custom.createcustom_state:write
GET/states.custom.getNone
POST/states.custom.getNone
GET/states.custom.listNone
POST/states.custom.listNone
POST/states.custom.updatecustom_state:write

Organizations

MethodAPI pathRequired scope
GET/dev-orgs.getdev_org:read,dev_org:write
POST/dev-orgs.getdev_org:read,dev_org:write

Users

MethodAPI pathRequired scope
POST/dev-users.activatedev_user:write,dev_user:all
POST/dev-users.createdev_user:write,dev_user:all
POST/dev-users.deactivatedev_user:all
GET/dev-users.getdev_user:read,dev_user:write,dev_user:all
POST/dev-users.getdev_user:read,dev_user:write,dev_user:all
POST/dev-users.identities.linkdev_user:write,dev_user:all
POST/dev-users.identities.unlinkdev_user:write,dev_user:all
GET/dev-users.listdev_user:read,dev_user:write,dev_user:all
POST/dev-users.listdev_user:read,dev_user:write,dev_user:all
POST/dev-users.mergedev_user:all
GET/dev-users.selfNone — Default Scopes unavailable for this API.
POST/dev-users.selfNone — Default Scopes unavailable for this API.
POST/dev-users.self.updateNone — Default Scopes unavailable for this API.
POST/dev-users.updatedev_user:write,dev_user:all

Directory

MethodAPI pathRequired scope
GET/directories.countdirectory:read,directory:write,directory:all
POST/directories.countdirectory:read,directory:write,directory:all
POST/directories.createdirectory:write,directory:all
POST/directories.deletedirectory:all
GET/directories.getdirectory:read,directory:write,directory:all
POST/directories.getdirectory:read,directory:write,directory:all
GET/directories.listdirectory:read,directory:write,directory:all
POST/directories.listdirectory:read,directory:write,directory:all
POST/directories.updatedirectory:write,directory:all

Groups

MethodAPI pathRequired scope
POST/groups.creategroup:write,group:all
GET/groups.getgroup:read,group:write,group:all
POST/groups.getgroup:read,group:write,group:all
GET/groups.listgroup:read,group:write,group:all
POST/groups.listgroup:read,group:write,group:all
POST/groups.members.addgroup_membership:all
GET/groups.members.listgroup_membership:read,group_membership:all
POST/groups.members.listgroup_membership:read,group_membership:all
POST/groups.members.removegroup_membership:all
POST/groups.updategroup:write,group:all

Jobs

MethodAPI pathRequired scope
GET/jobs.getjob:read
POST/jobs.getjob:read
GET/jobs.listjob:read
POST/jobs.listjob:read

Keyrings

MethodAPI pathRequired scope
GET/keyrings.authorizekeyring:read
POST/keyrings.authorizekeyring:read

MethodAPI pathRequired scope
POST/links.createlink:write,link:all — Also needs linked objects read access.
POST/links.deletelink:all — Also needs linked objects read access.
GET/links.getlink:read,link:write,link:all
POST/links.getlink:read,link:write,link:all
GET/links.listlink:read,link:write,link:all
POST/links.listlink:read,link:write,link:all
POST/links.replacelink:write,link:all — Also needs linked objects read access.

Meetings

MethodAPI pathRequired scope
GET/meetings.countmeeting:read,meeting:write,meeting:all
POST/meetings.countmeeting:read,meeting:write,meeting:all
POST/meetings.createmeeting:write,meeting:all
POST/meetings.deletemeeting:all
GET/meetings.getmeeting:read,meeting:write,meeting:all
POST/meetings.getmeeting:read,meeting:write,meeting:all
GET/meetings.listmeeting:read,meeting:write,meeting:all
POST/meetings.listmeeting:read,meeting:write,meeting:all
POST/meetings.updatemeeting:write,meeting:all

Observability

MethodAPI pathRequired scope
POST/observability.sessions.aggregateNone
GET/observability.sessions.data.getNone
POST/observability.sessions.data.getNone
GET/observability.sessions.developer-info.getNone
POST/observability.sessions.developer-info.getNone
GET/observability.sessions.getNone
POST/observability.sessions.getNone
GET/observability.sessions.listNone
POST/observability.sessions.listNone

Parts

MethodAPI pathRequired scope
POST/parts.createcapability: capability:write, capability:all
enhancement: enhancement:write, enhancement:all
feature: feature:write, feature:all
product: product:write, product:all
POST/parts.deletecapability: capability:all
enhancement: enhancement:all
feature: feature:all
product: product:all
GET/parts.getcapability: capability:read, capability:write, capability:all
enhancement: enhancement:read, enhancement:write, enhancement:all
feature: feature:read, feature:write, feature:all
product: product:read, product:write, product:all
POST/parts.getcapability: capability:read, capability:write, capability:all
enhancement: enhancement:read, enhancement:write, enhancement:all
feature: feature:read, feature:write, feature:all
product: product:read, product:write, product:all
GET/parts.listcapability: capability:read, capability:write, capability:all
enhancement: enhancement:read, enhancement:write, enhancement:all
feature: feature:read, feature:write, feature:all
product: product:read, product:write, product:all
POST/parts.listcapability: capability:read, capability:write, capability:all
enhancement: enhancement:read, enhancement:write, enhancement:all
feature: feature:read, feature:write, feature:all
product: product:read, product:write, product:all
POST/parts.updatecapability: capability:write, capability:all
enhancement: enhancement:write, enhancement:all
feature: feature:write, feature:all
product: product:write, product:all

Workspaces

MethodAPI pathRequired scope
POST/rev-orgs.createrev_org:write,rev_org:all
POST/rev-orgs.deleterev_org:all
GET/rev-orgs.getrev_org:read,rev_org:write,rev_org:all
POST/rev-orgs.getrev_org:read,rev_org:write,rev_org:all
GET/rev-orgs.listrev_org:read,rev_org:write,rev_org:all
POST/rev-orgs.listrev_org:read,rev_org:write,rev_org:all
POST/rev-orgs.updaterev_org:write,rev_org:all

Customers

MethodAPI pathRequired scope
POST/rev-users.createrev_user:write,rev_user:all
POST/rev-users.deleterev_user:all
GET/rev-users.getrev_user:read,rev_user:write,rev_user:all
POST/rev-users.getrev_user:read,rev_user:write,rev_user:all
GET/rev-users.listrev_user:read,rev_user:write,rev_user:all
POST/rev-users.listrev_user:read,rev_user:write,rev_user:all
POST/rev-users.mergerev_user:all
GET/rev-users.scanrev_user:read,rev_user:write,rev_user:all
POST/rev-users.scanrev_user:read,rev_user:write,rev_user:all
POST/rev-users.updaterev_user:write,rev_user:all

Schedules

MethodAPI pathRequired scope
POST/org-schedule-fragments.createorg_schedule_fragment:write,org_schedule_fragment:all
GET/org-schedule-fragments.getorg_schedule_fragment:read,org_schedule_fragment:write,org_schedule_fragment:all
POST/org-schedule-fragments.getorg_schedule_fragment:read,org_schedule_fragment:write,org_schedule_fragment:all
POST/org-schedule-fragments.transitionorg_schedule_fragment:write,org_schedule_fragment:all
POST/org-schedules.createorg_schedule:write,org_schedule:all
GET/org-schedules.evaluateorg_schedule:read,org_schedule:write,org_schedule:all
POST/org-schedules.evaluateorg_schedule:read,org_schedule:write,org_schedule:all
GET/org-schedules.getorg_schedule:read,org_schedule:write,org_schedule:all
POST/org-schedules.getorg_schedule:read,org_schedule:write,org_schedule:all
GET/org-schedules.listorg_schedule:read,org_schedule:write,org_schedule:all
POST/org-schedules.listorg_schedule:read,org_schedule:write,org_schedule:all
POST/org-schedules.set-futureorg_schedule:write,org_schedule:all
POST/org-schedules.transitionorg_schedule:write,org_schedule:all
POST/org-schedules.updateorg_schedule:write,org_schedule:all

Service accounts

MethodAPI pathRequired scope
POST/service-accounts.createNone — Not accessible via service account tokens. Requires user authentication.
GET/service-accounts.getsvcacc:read
POST/service-accounts.getsvcacc:read

Slas

MethodAPI pathRequired scope
POST/metric-action.executeNone
POST/metric-definitions.createmetric_definition:write,metric_definition:all
POST/metric-definitions.deletemetric_definition:all
GET/metric-definitions.getmetric_definition:read,metric_definition:write,metric_definition:all
POST/metric-definitions.getmetric_definition:read,metric_definition:write,metric_definition:all
GET/metric-definitions.listmetric_definition:read,metric_definition:write,metric_definition:all
POST/metric-definitions.listmetric_definition:read,metric_definition:write,metric_definition:all
POST/metric-definitions.updatemetric_definition:write,metric_definition:all
GET/metric-trackers.getNone
POST/metric-trackers.getNone
GET/sla-trackers.getNone
POST/sla-trackers.getNone
GET/sla-trackers.listNone
POST/sla-trackers.listNone
POST/slas.assignsla:write
POST/slas.createsla:write
GET/slas.getsla:read,sla:write
POST/slas.getsla:read,sla:write
GET/slas.listsla:read,sla:write
POST/slas.listsla:read,sla:write
POST/slas.transitionsla:write
POST/slas.updatesla:write

Snap kit execution

MethodAPI pathRequired scope
POST/snap-kit-action.execute.deferredsnap_widget:write,snap_widget:all

Snap widgets

MethodAPI pathRequired scope
POST/snap-widgets.createsnap_widget:write,snap_widget:all

Surveys

MethodAPI pathRequired scope
POST/surveys.createsurvey:write,survey:all
POST/surveys.deletesurvey:all
GET/surveys.getsurvey:read,survey:write,survey:all
POST/surveys.getsurvey:read,survey:write,survey:all
GET/surveys.listsurvey:read,survey:write,survey:all
POST/surveys.listsurvey:read,survey:write,survey:all
GET/surveys.responses.listsurvey_response:read,survey_response:write,survey_response:all
POST/surveys.responses.listsurvey_response:read,survey_response:write,survey_response:all
POST/surveys.responses.updatesurvey_response:write,survey_response:all
POST/surveys.sendsurvey:write,survey:all
POST/surveys.submitsurvey_response:write,survey_response:all
POST/surveys.updatesurvey:write,survey:all

System users

MethodAPI pathRequired scope
GET/sys-users.listNone — Default Scopes unavailable for this API.
POST/sys-users.listNone — Default Scopes unavailable for this API.
POST/sys-users.updateNone — Default Scopes unavailable for this API.

Tags

MethodAPI pathRequired scope
POST/tags.createtag:write,tag:all
POST/tags.deletetag:all
GET/tags.gettag:read,tag:write,tag:all
POST/tags.gettag:read,tag:write,tag:all
GET/tags.listtag:read,tag:write,tag:all
POST/tags.listtag:read,tag:write,tag:all
POST/tags.updatetag:write,tag:all

Timeline entries

MethodAPI pathRequired scope
GET/reactions.listNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
POST/reactions.listNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
POST/reactions.updateNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
POST/timeline-entries.createNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
POST/timeline-entries.deleteNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
GET/timeline-entries.getNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
POST/timeline-entries.getNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
GET/timeline-entries.listNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
POST/timeline-entries.listNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
POST/timeline-entries.updateNone — Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).

Vistas

MethodAPI pathRequired scope
POST/vistas.deletevista:all
GET/vistas.getvista:read,vista:write,vista:all
POST/vistas.getvista:read,vista:write,vista:all
POST/vistas.groups.deletevista:all — No scopes required for default vistas.
GET/vistas.groups.getvista:read,vista:write,vista:all — No scopes required for default vistas.
POST/vistas.groups.getvista:read,vista:write,vista:all — No scopes required for default vistas.
GET/vistas.groups.listvista:read,vista:write,vista:all — No scopes required for default vistas.
POST/vistas.groups.listvista:read,vista:write,vista:all — No scopes required for default vistas.
GET/vistas.listvista:read,vista:write,vista:all
POST/vistas.listvista:read,vista:write,vista:all

Web crawler job

MethodAPI pathRequired scope
POST/web-crawler-jobs.controlweb_crawler_job:all
POST/web-crawler-jobs.createweb_crawler_job:all
GET/web-crawler-jobs.getweb_crawler_job:all
POST/web-crawler-jobs.getweb_crawler_job:all
GET/web-crawler-jobs.listweb_crawler_job:all
POST/web-crawler-jobs.listweb_crawler_job:all

Webhooks

MethodAPI pathRequired scope
POST/webhooks.createNone — Default Scopes unavailable for this API.
POST/webhooks.deleteNone — Default Scopes unavailable for this API.
POST/webhooks.eventNone — Default Scopes unavailable for this API.
GET/webhooks.getNone — Default Scopes unavailable for this API.
POST/webhooks.getNone — Default Scopes unavailable for this API.
GET/webhooks.listNone — Default Scopes unavailable for this API.
POST/webhooks.listNone — Default Scopes unavailable for this API.
POST/webhooks.updateNone — Default Scopes unavailable for this API.

Works

MethodAPI pathRequired scope
GET/works.countincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
POST/works.countincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
POST/works.createincident: incident:write, incident:all
issue: issue:write, issue:all
opportunity: opportunity:write, opportunity:all
task: task:write, task:all
ticket: ticket:write, ticket:all
POST/works.deleteincident: incident:all
issue: issue:all
opportunity: opportunity:all
task: task:all
ticket: ticket:all
GET/works.exportincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
POST/works.exportincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
GET/works.getincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
POST/works.getincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
GET/works.listincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
POST/works.listincident: incident:read, incident:write, incident:all
issue: issue:read, issue:write, issue:all
opportunity: opportunity:read, opportunity:write, opportunity:all
task: task:read, task:write, task:all
ticket: ticket:read, ticket:write, ticket:all
POST/works.updateincident: incident:write, incident:all
issue: issue:write, issue:all
opportunity: opportunity:write, opportunity:all
task: task:write, task:all
ticket: ticket:write, ticket:all

Last updated on