Skip to content
Search
Search the documentation
OAuthScope
GitHub GitHub

OAuthScope

Type Alias: OAuthScope

OAuthScope = "user.identify" | "user.projects.read" | "user.projects.write" | "project.information.read" | "project.information.write" | "project.votes.read" | "project.metrics.write" | "project.announcements.write" | "project.webhooks.read" | "project.webhooks.write" | "project.integrations.read" | "project.integrations.write"

Defined in: v1/types/oauth.ts:16

Scopes that can be requested when registering an OAuth app and sending users through the consent screen. Access is scoped - only request the scopes you actually use. A write scope includes its read counterpart (e.g. project.webhooks.write also allows listing webhooks).

user.* scopes apply to the authorizing user. project.* scopes apply to every project the user selected during authorization.