Skip to content

Social SDK: Add OAuth Communications Scope warnings #7653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 30, 2025

Conversation

markmandel
Copy link
Contributor

@markmandel markmandel commented Jun 30, 2025

Devs keep running into the issue that they aren't aware that to use communication features, they need to enable communication OAuth scopes (mainly because we're not explicit about it anywhere).

This aims to fix this! This PR includes:

  • Reorganize core concepts page to prioritize OAuth scopes
  • Add implementation details to OAuth guide
  • Add warnings to guides using Communications features about scope requirements

@markmandel markmandel requested a review from a team as a code owner June 30, 2025 23:10
@markmandel markmandel added the social-sdk Feedback and PRs on Social SDK label Jun 30, 2025
* [Presence & Rich Presence](/docs/discord-social-sdk/core-concepts#presence-rich-presence)

The Social SDK provides the helper method [`Client::GetDefaultPresenceScopes`], which returns `openid sdk.social_layer_presence`,
that you can use when setting up your OAuth2 flow, for integrations that only needs the above functionality.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
that you can use when setting up your OAuth2 flow, for integrations that only needs the above functionality.
that you can use when setting up your OAuth2 flow, for integrations that only need the above functionality.

Not sure which is grammatically correct but I think this reads better

Devs keep running into the issue that they aren't aware that to use
communication features, they need to enable communication OAuth scopes
(mainly because we're not explicit about it anywhere).

This aims to fix this! This PR includes:

- Reorganize core concepts page to prioritize OAuth scopes
- Add implementation details to OAuth guide
- Add warnings to guides using Communications features about scope
requirements
Copy link
Contributor

@anthonydiscord anthonydiscord left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!


### Default Communication Scopes

The communications features are currently available but have limited access. Those features **require** the following scope
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The communications features are currently available but have limited access. Those features **require** the following scope
The communications features are currently available but have limited access. Those features **require** the scope

I think this reads a little better

@markmandel
Copy link
Contributor Author

Preview:
image

@markmandel
Copy link
Contributor Author

image


image


image


image

@markmandel markmandel merged commit 8e93a93 into discord:main Jun 30, 2025
4 checks passed
@markmandel markmandel deleted the social-sdk/scopes branch July 1, 2025 00:10
mazylol pushed a commit to mazylol/discord-api-docs that referenced this pull request Jul 3, 2025
* Social SDK: Add OAuth Communications Scope warnings

Devs keep running into the issue that they aren't aware that to use
communication features, they need to enable communication OAuth scopes
(mainly because we're not explicit about it anywhere).

This aims to fix this! This PR includes:

- Reorganize core concepts page to prioritize OAuth scopes
- Add implementation details to OAuth guide
- Add warnings to guides using Communications features about scope
requirements

* Review updates.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
social-sdk Feedback and PRs on Social SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants