Difference between revisions of "OAuth"

From Neos Wiki
Jump to navigation Jump to search
Line 13: Line 13:
 
** Manage / Read your Friends List
 
** Manage / Read your Friends List
 
* etc.
 
* etc.
 +
 +
= OAuth Requirements =
 +
In order to use OAuth you will need:
 +
* A registered application/client with Neos - This is currently a manual process please email [mailto:hello@neos.com hello@neos.com] to request an account
 +
* A webserver - OAuth requires a web application / server to process the OAuth authorization process.
  
 
= Example Scenarios =
 
= Example Scenarios =
Line 20: Line 25:
 
* Utilities / Applications - Manage your Friends, Messages etc outside of Neos using a 3rd Party Application.
 
* Utilities / Applications - Manage your Friends, Messages etc outside of Neos using a 3rd Party Application.
 
* Management - Edit your Neos Profile/Inventory from outside of Neos.
 
* Management - Edit your Neos Profile/Inventory from outside of Neos.
 +
 +
= Common Misconceptions =
 +
OAuth is a complex feature and using it within Neos, can end up with some misconceptions about what it is or how it works:
 +
* OAuth Cannot access your Neos Account without your Consent
 +
* OAuth cannot be used with LogiX, this may change in the future. OAuth requires a responding web service/server to listen to incoming authorization requests and your Neos world or session is currently not capable of doing this correctly.
 +
* OAuth won't allow you to access other accounts such as Google, Facebook etc via LogiX or in game. This would be a different feature to integrate those systems/apis.

Revision as of 23:50, 3 May 2021

What is OAuth?

OAuth is an open standard which allows other applications on the internet to access your Neos Account details without you sharing your Neos Password with them. OAuth provides a consent based process that ensures that you as a User agree to grant these applications access before any data is exchanged. OAuth is commonly implemented and seen across the internet and many applications support it.

Neos' OAuth Status

Neos' OAuth is in the very early stages, using it requires registration which is currently only possible with manual approval. Once you have registered you cannot do much with OAuth and Neos right now but this will be expanded in the future to allow things like:

  • Account Linking / Letting another application know who you are.
  • Profile Information Sharing
  • Providing other Applications with the ability to:
    • Manage / Read your Messages
    • Manage / Read your Friends List
  • etc.

OAuth Requirements

In order to use OAuth you will need:

  • A registered application/client with Neos - This is currently a manual process please email hello@neos.com to request an account
  • A webserver - OAuth requires a web application / server to process the OAuth authorization process.

Example Scenarios

Neos' OAuth will allow you to allow other applications to know about you as a Neos User. None of these applications exist, these are just examples of what you might be able to do with OAuth in the future.

  • Event Registration - As a part of an event registration system, you could be asked to link your Neos Account with the Event Registration System. This would securely identify and prove that you were a particular Neos User which could allow you access to Paid Events, Sessions and Workshops etc.
  • Utilities / Applications - Manage your Friends, Messages etc outside of Neos using a 3rd Party Application.
  • Management - Edit your Neos Profile/Inventory from outside of Neos.

Common Misconceptions

OAuth is a complex feature and using it within Neos, can end up with some misconceptions about what it is or how it works:

  • OAuth Cannot access your Neos Account without your Consent
  • OAuth cannot be used with LogiX, this may change in the future. OAuth requires a responding web service/server to listen to incoming authorization requests and your Neos world or session is currently not capable of doing this correctly.
  • OAuth won't allow you to access other accounts such as Google, Facebook etc via LogiX or in game. This would be a different feature to integrate those systems/apis.