Skip to content

Commit 077b977

Browse files
committed
Updates README
1 parent 45bf8ff commit 077b977

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

+55
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,61 @@ The client keys used with Parse are no longer necessary with parse-server. If y
3636
* restAPIKey
3737
* dotNetKey
3838

39+
#### OAuth Support
40+
41+
parse-server supports 3rd party authentication with
42+
43+
* Twitter
44+
* Meetup
45+
* Linkedin
46+
* Google
47+
* Instagram
48+
* Facebook
49+
50+
51+
Configuration options for these 3rd-party modules is done with the oauth option passed to ParseServer:
52+
53+
```
54+
{
55+
oauth: {
56+
twitter: {
57+
consumer_key: "", // REQUIRED
58+
consumer_secret: "" // REQUIRED
59+
},
60+
facebook: {
61+
appIds: "FACEBOOK APP ID"
62+
}
63+
}
64+
65+
}
66+
```
67+
68+
#### Custom Authentication
69+
70+
It is possible to leverage the OAuth support with any 3rd party authentication that you bring in.
71+
72+
```
73+
{
74+
75+
oauth: {
76+
my_custom_auth: {
77+
module: "PATH_TO_MODULE" // OR object,
78+
option1: "",
79+
option2: "",
80+
}
81+
}
82+
}
83+
```
84+
85+
On this module, you need to implement and export those two functions `validateAuthData(authData, options) {} ` and `validateAppId(appIds, authData) {}`.
86+
87+
For more informations about custom auth please see the examples:
88+
89+
- [facebook OAuth](https://github.com/ParsePlatform/parse-server/blob/master/src/oauth/facebook.js)
90+
- [twitter OAuth](https://github.com/ParsePlatform/parse-server/blob/master/src/oauth/twitter.js)
91+
- [instagram OAuth](https://github.com/ParsePlatform/parse-server/blob/master/src/oauth/instagram.js)
92+
93+
3994
#### Advanced options:
4095

4196
* filesAdapter - The default behavior (GridStore) can be changed by creating an adapter class (see [`FilesAdapter.js`](https://github.com/ParsePlatform/parse-server/blob/master/src/Adapters/Files/FilesAdapter.js))

0 commit comments

Comments
 (0)