Skip to content
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

Missing lot's of documentation in order to create a custom authentication #934

Closed
rhuanbarreto opened this issue Sep 25, 2019 · 5 comments · Fixed by #963
Closed

Missing lot's of documentation in order to create a custom authentication #934

rhuanbarreto opened this issue Sep 25, 2019 · 5 comments · Fixed by #963
Labels
type:docs Only change in the docs or README

Comments

@rhuanbarreto
Copy link

I'm trying to create a custom authentication using Keycloak OpenID Connect Provider as a source for authentication and I'm stumbling over many docs about how to create a custom authentication in order to support it as:

And in the end, some of the code mentioned on the docs are missing documentation in the SDK, as:

And then I needed to read all the source in order to understand how the things work. I'm still developing the custom authentication, but I'm not fully aware of the inner workings on this, so for now I can't help opening a PR and doing this myself, but it's my duty to open an issue and point this out so all the community can improve it.

@dplewis
Copy link
Member

dplewis commented Sep 25, 2019

https://docs.parseplatform.org/js/guide/#custom-authentication-module

Everything should be there to create a custom auth.

I can open a PR to document those functions.

@rhuanbarreto
Copy link
Author

I thinks it's better. It's still not clear to me that for making a login, you need to create this provider. This could be better explained on why do you need each function in the provider and how it connects internally in the SDK.

In the end I didn't need to do more than the server. I'm using the rest API now, because it seems more convenient than creating this provider. But soon I will make an extension to the SDK to support Keycloak like the FacebookUtils.

@rhuanbarreto
Copy link
Author

Also it's important to mention that an ID field is mandatory in order to make the 3rd party login work. I could understand it reading the other authentication methods.

@dplewis
Copy link
Member

dplewis commented Sep 27, 2019

You are right. id field is required and I don’t think hyphen names modules work either.

@davimacedo davimacedo added the type:docs Only change in the docs or README label Sep 27, 2019
@dplewis
Copy link
Member

dplewis commented Oct 10, 2019

@rhuanbarreto Can you open a PR? We will gladly review it.

dplewis added a commit that referenced this issue Oct 18, 2019
Closes: #934

Adds deprecation for _linkWith and _loginWith
dplewis added a commit that referenced this issue Oct 18, 2019
* Missing documentation for Custom Auth

Closes: #934

Adds deprecation for _linkWith and _loginWith

* Add 2.9.0 version

* eslint specific rule

* update readme and unit tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs Only change in the docs or README
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants