Skip to content
Search
Search the documentation
OAuthScopeSchema
GitHub GitHub

OAuthScopeSchema

Variable: OAuthScopeSchema

const OAuthScopeSchema: ZodMiniEnum<{ project.announcements.write: "project.announcements.write"; project.information.read: "project.information.read"; project.information.write: "project.information.write"; project.integrations.read: "project.integrations.read"; project.integrations.write: "project.integrations.write"; project.metrics.write: "project.metrics.write"; project.votes.read: "project.votes.read"; project.webhooks.read: "project.webhooks.read"; project.webhooks.write: "project.webhooks.write"; user.identify: "user.identify"; user.projects.read: "user.projects.read"; user.projects.write: "user.projects.write"; }>

Defined in: v1/schemas/oauth.ts:17

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.