groot/automatisch
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #957 from automatisch/oauth-docs

Browse Source 
docs: Explain OAuth preference for app connections
This commit is contained in:
Ömer Faruk Aydın
2023-02-25 11:02:50 +01:00
committed by GitHub
parent 61ceffc6f9 0d1b35edc5
commit 0a274ebadb
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/docs/pages/build-integrations/auth.md
View File

@@ -93,6 +93,10 @@ We have defined two fields for the auth.
You have to add a screen name field in case there is no API endpoint where you can get the username or any other information about the user that you can use as a screen name. Some of the APIs have an endpoint for this purpose like `/me` or `/users/me`, but in our example, the cat API doesn't have such an endpoint.
:::
:::danger
If the third-party service you use provides both an API key and OAuth for the authentication, we expect you to use OAuth instead of an API key. Please consider that when you create a pull request for a new integration. Otherwise, we might ask you to have changes to use OAuth. To see apps with OAuth implementation, you can check [examples](/build-integrations/examples#_3-legged-oauth).
:::
## Verify credentials
So until now, we integrated auth folder with the app definition and defined the auth fields. Now we need to verify the credentials that the user entered. We will do that by defining the `verifyCredentials` method.