+- OnXbox Community (https://forums.onxbox.co)
+-- Forum: Annoucements (https://forums.onxbox.co/forum-1.html)
+--- Forum: News (https://forums.onxbox.co/forum-2.html)
+--- Thread: API scope changes (/thread-2.html)
API scope changes - MrKirbeh - 01-30-2023
Exciting New Scopes: Access OnXbox Community Data with Granular Control!
Hey everyone!
We've got some great news regarding how you can access different types of data through our service. We're introducing new, specific scopes to give you incredibly fine-grained control and access to our OnXbox Community information!
Introducing New Community Scopes for OnXbox:
We're rolling out a comprehensive set of new scopes for those looking to integrate with our OnXbox Community data. These will allow your applications to request only the specific permissions they need:
User Profile & Avatar Scopes:
-
- community.profile.read: Allows reading basic user profile information (e.g., username, registration date, custom profile fields, excluding sensitive data).
- community.profile.write: Allows modifying user profile information (e.g., updating custom profile fields, location, interests).
- community.avatar.read: Allows reading a user's current avatar/profile picture URL.
- community.avatar.write: Allows uploading or changing a user's avatar/profile picture.
Private Message (PM) Scopes:
-
- community.pm.all: Grants comprehensive access to all private message functions, including reading all messages (inbox, sent, drafts, trash, custom folders), sending new messages, creating and deleting custom folders (users cannot delete default folders), and deleting messages.
- community.pm.read: Allows reading all private messages across all folders (inbox, sent, drafts, trash, custom folders). This is a broad read scope.
- community.pm.read.inbox: Specifically allows reading messages only in the user's inbox.
- community.pm.read.sent: Specifically allows reading messages only in the user's sent items folder.
- community.pm.read.drafts: Specifically allows reading messages only in the user's drafts folder.
- community.pm.read.trash: Specifically allows reading messages only in the user's trash folder.
- community.pm.send: Allows sending new private messages to other users.
- community.pm.create_draft: Allows creating new private message drafts.
- community.pm.manage_folders: Allows creating, renaming, or deleting custom private message folders.
- community.pm.delete: Allows deleting private messages from any folder.
Forum Content (Threads & Posts) Scopes:
-
- community.threads.read: Allows reading content of forum threads/topics.
- community.threads.create: Allows creating new forum threads/topics in permitted forums.
- community.threads.edit: Allows editing existing forum threads/topics created by the user (or if the user has moderation permissions).
- community.threads.delete: Allows deleting forum threads/topics created by the user (or if the user has moderation permissions).
- community.posts.read: Allows reading individual posts within forum threads.
- community.posts.create: Allows creating new replies/posts within existing forum threads.
- community.posts.edit: Allows editing existing posts created by the user (or if the user has moderation permissions).
- community.posts.delete: Allows deleting posts created by the user (or if the user has moderation permissions).
General Community Interaction Scopes (Optional):
-
- community.warnings.read: Allows reading a user's warning history on the forum.
- community.reputation.read: Allows reading a user's reputation score.
- community.reputation.write: Allows giving or modifying reputation to other users.
- community.search: Allows performing searches across the forum content.
Existing Xbox Scopes Remain Unchanged:
For clarity and continuity, please note that your existing:
-
- "friends" scope will continue to provide Xbox friends data.
- "profile" scope will continue to provide your Xbox profile data.
This means applications already using these scopes for Xbox data do not need to make any changes and will continue to function exactly as they do now.
---
We believe these new dedicated scopes will offer greater flexibility and clearer data access for everyone building with OnXbox!
Thanks,
MrKirbeh