Skip to main content

OAuth2Scope

@discordeno/bot


Documentation / @discordeno/bot / OAuth2Scope

Enumeration: OAuth2Scope

Defined in: packages/types/dist/types/discord/oauth2.d.ts:7

https://discord.com/developers/docs/topics/oauth2#shared-resources-oauth2-scopes

Enumeration Members

ActivitiesRead

ActivitiesRead: "activities.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:14

Allows your app to fetch data from a user's "Now Playing/Recently Played" list

Remarks

This scope is not currently available for apps


ActivitiesWrite

ActivitiesWrite: "activities.write"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:21

Allows your app to update a user's activity

Remarks

This scope not currently available for apps.


ApplicationCommandsPermissionsUpdate

ApplicationCommandsPermissionsUpdate: "applications.commands.permissions.update"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:41

Allows your app to update permissions for its commands in a guild a user has permissions to


ApplicationsBuildsRead

ApplicationsBuildsRead: "applications.builds.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:23

Allows your app to read build data for a user's applications


ApplicationsBuildsUpload

ApplicationsBuildsUpload: "applications.builds.upload"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:30

Allows your app to upload/update builds for a user's applications

Remarks

This scope requires Discord approval to be used


ApplicationsCommands

ApplicationsCommands: "applications.commands"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:32

Allows your app to add commands to a guild - included by default with the bot scope


ApplicationsCommandsUpdate

ApplicationsCommandsUpdate: "applications.commands.update"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:39

Allows your app to update its Application Commands via this bearer token

Remarks

This scope can only be used when using a Client Credential Grant


ApplicationsEntitlements

ApplicationsEntitlements: "applications.entitlements"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:43

Allows your app to read entitlements for a user's applications


ApplicationsStoreUpdate

ApplicationsStoreUpdate: "applications.store.update"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:45

Allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications


Bot

Bot: "bot"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:47

For oauth2 bots, this puts the bot in the user's selected guild by default


Connections

Connections: "connections"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:49

Allows requests to /users/@me/connections


DMChannelsRead

DMChannelsRead: "dm_channels.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:56

Allows your app to see information about the user's DMs and group DMs

Remarks

This scope requires Discord approval to be used


Email

Email: "email"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:58

Adds the email filed to /users/@me


GroupDMJoins

GroupDMJoins: "gdm.join"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:60

Allows your app to join users to a group dm


Guilds

Guilds: "guilds"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:62

Allows requests to /users/@me/guilds


GuildsJoin

GuildsJoin: "guilds.join"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:64

Allows requests to /guilds/{guild.id}/members/{user.id}


GuildsMembersRead

GuildsMembersRead: "guilds.members.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:66

Allows requests to /users/@me/guilds/{guild.id}/member


Identify

Identify: "identify"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:74

Allows requests to /users/@me

Remarks

The return object from /users/@me does NOT contain the email field unless the scope email is also used


MessagesRead

MessagesRead: "messages.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:79

For local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)


RelationshipsRead

RelationshipsRead: "relationships.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:86

Allows your app to know a user's friends and implicit relationships

Remarks

This scope requires Discord approval to be used


RoleConnectionsWrite

RoleConnectionsWrite: "role_connections.write"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:88

Allows your app to update a user's connection and metadata for the app


RPC

RPC: "rpc"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:95

For local rpc server access, this allows you to control a user's local Discord client

Remarks

This scope requires Discord approval to be used


RPCActivitiesWrite

RPCActivitiesWrite: "rpc.activities.write"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:102

For local rpc server access, this allows you to update a user's activity

Remarks

This scope requires Discord approval to be used


RPCNotificationsRead

RPCNotificationsRead: "rpc.notifications.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:109

For local rpc server api access, this allows you to receive notifications pushed out to the user

Remarks

This scope requires Discord approval to be used


RPCVoiceRead

RPCVoiceRead: "rpc.voice.read"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:116

For local rpc server access, this allows you to read a user's voice settings and listen for voice events

Remarks

This scope requires Discord approval to be used


RPCVoiceWrite

RPCVoiceWrite: "rpc.voice.write"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:123

For local rpc server access, this allows you to update a user's voice settings

Remarks

This scope requires Discord approval to be used


Voice

Voice: "voice"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:130

Allows your app to connect to voice on user's behalf and see all the voice members

Remarks

This scope requires Discord approval to be used


WebhookIncoming

WebhookIncoming: "webhook.incoming"

Defined in: packages/types/dist/types/discord/oauth2.d.ts:132

Generate a webhook that is returned in the oauth token response for authorization code grants