Skip to main content

OAuth2Scope

Documentation

Documentation / @discordeno/types / OAuth2Scope

Enumeration: OAuth2Scope

Defined in: discord/oauth2.ts:9

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

Enumeration Members​

ActivitiesRead​

ActivitiesRead: "activities.read"

Defined in: discord/oauth2.ts:16

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: discord/oauth2.ts:23

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: discord/oauth2.ts:43

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

ApplicationsBuildsRead​

ApplicationsBuildsRead: "applications.builds.read"

Defined in: discord/oauth2.ts:25

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

ApplicationsBuildsUpload​

ApplicationsBuildsUpload: "applications.builds.upload"

Defined in: discord/oauth2.ts:32

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: discord/oauth2.ts:34

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

ApplicationsCommandsUpdate​

ApplicationsCommandsUpdate: "applications.commands.update"

Defined in: discord/oauth2.ts:41

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: discord/oauth2.ts:45

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

ApplicationsStoreUpdate​

ApplicationsStoreUpdate: "applications.store.update"

Defined in: discord/oauth2.ts:47

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

Bot​

Bot: "bot"

Defined in: discord/oauth2.ts:49

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

Connections​

Connections: "connections"

Defined in: discord/oauth2.ts:51

Allows requests to /users/@me/connections

DMChannelsRead​

DMChannelsRead: "dm_channels.read"

Defined in: discord/oauth2.ts:58

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: discord/oauth2.ts:60

Adds the email filed to /users/@me

GroupDMJoins​

GroupDMJoins: "gdm.join"

Defined in: discord/oauth2.ts:62

Allows your app to join users to a group dm

Guilds​

Guilds: "guilds"

Defined in: discord/oauth2.ts:64

Allows requests to /users/@me/guilds

GuildsJoin​

GuildsJoin: "guilds.join"

Defined in: discord/oauth2.ts:66

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

GuildsMembersRead​

GuildsMembersRead: "guilds.members.read"

Defined in: discord/oauth2.ts:68

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

Identify​

Identify: "identify"

Defined in: discord/oauth2.ts:76

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: discord/oauth2.ts:81

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: discord/oauth2.ts:89

Allows your app to access a user's Discord Friends list, their pending requests, and blocked users.

Remarks​

This scope is part of the Social SDK. You need to submit for access in the dev portal to use this scope.

RoleConnectionsWrite​

RoleConnectionsWrite: "role_connections.write"

Defined in: discord/oauth2.ts:91

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

RPC​

RPC: "rpc"

Defined in: discord/oauth2.ts:98

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: discord/oauth2.ts:105

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: discord/oauth2.ts:112

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: discord/oauth2.ts:119

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: discord/oauth2.ts:126

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: discord/oauth2.ts:133

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: discord/oauth2.ts:135

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