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

docs: Add explanation to include screenName in verify credentials

Browse Source
This commit is contained in:
Faruk AYDIN
2022-11-09 21:46:17 +01:00
parent 0d479426ed
commit 4b8ac0ff9c
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

@@ -142,6 +142,10 @@ export default verifyCredentials;
Here we send a request to the `/v1/images/search` endpoint with the API key. If we get a response from the API, we will set the screen name to the auth data. If we get an error response from the API, it will throw an error.
:::warning
You must always provide a `screenName` field to auth data in the `verifyCredentials` method. Otherwise, the connection will not have a name and it will not function properly in the user interface.
:::
## Is still verified?
We have implemented the `verifyCredentials` method. Now we need to check whether the credentials are still valid or not for the test connection functionality in Automatisch. We will do that by defining the `isStillVerified` method.