vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update credentials docs (#2420)

Browse Source
This commit is contained in:
Shuchang Zheng
2025-05-21 20:41:41 -07:00
committed by GitHub
parent fb41ff843e
commit 0b21f1accb
3 changed files with 16 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
fern/credentials/totp.mdx
View File

@@ -5,11 +5,16 @@ slug: credentials/totp
---
Skyvern supports one-time password (see https://www.twilio.com/docs/glossary/totp for more information), also known as 2FA/MFA. For Skyvern to get the code, there are three options:
- [Option 1: Skyvern gets the code from your endpoint](#option-1-get-code-from-your-endpoint)
- [Option 2: You push the code to Skyvern](#option-2-push-code-to-skyvern)
- [Option 3: Store your 2FA/MFA secret in Skyvern's credential management tool](#option-3-store-your-2famfa-secret-in-the-skyvern-credential-tool)
- [Option 1: Store your 2FA/MFA secret in Skyvern Credential tool](#option-1-store-your-2famfa-secret-in-the-skyvern-credential-tool)
- [Option 2: Skyvern gets the code from your endpoint](#option-2-get-code-from-your-endpoint)
- [Option 3: You push the code to Skyvern](#option-3-push-code-to-skyvern)
## Option 1: Get Code From Your Endpoint
## Option 1: Store your 2FA/MFA secret in the Skyvern Credential tool
Save your username and password in [Skyvern Credential](https://app.skyvern.com/credentials) where you can also store your 2FA/MFA key/secret.
See [Password Management](/credentials/passwords#manage-passwords-in-skyvern-cloud) for more details.
## Option 2: Get Code From Your Endpoint
You can pass `totp_verification_url` when [creating a task](/running-tasks/api-spec#request-initiate-a-task). Inside this endpoint hosted by you, you have to conform to the following schema:
### Set Up Your TOTP Endpoint
@@ -44,7 +49,7 @@ def validate_skyvern_request_headers(request: Request) -> bool:
SKYVERN_API_KEY: this is the [api key](/running-tasks/introduction) specific to your organization
## Option 2: Push Code To Skyvern
## Option 3: Push Code To Skyvern
You can pass `totp_identifier` when [creating a task](/running-tasks/api-spec#request-initiate-a-task). When the TOTP code arrives at your inbox or as a text message, all you need to do is to send the email/message (Gmail + Zapier integration can be a good solution to set up email forwarding) to Skyvern's TOTP receiver endpoint. See the [TOTP API for more details](https://docs.skyvern.com/api-reference/api-reference/credentials/send-totp-code).
### Forwarding Your Email To Skyvern (Gmail + Zapier)
@@ -125,10 +130,4 @@ In Zapier: under the “Test” of the Webhooks action, send a request to test i
<p align="center">
<img src="../images/totp/test_end_to_end.png"/>
</p>
## Option 3: Store your 2FA/MFA secret in the Skyvern Credential tool
Save your username and password in [Skyvern Credential](https://app.skyvern.com/credentials) where you can also store your 2FA/MFA key/secret.
See [Password Management](/credentials/passwords#manage-passwords-in-skyvern-cloud) for more details.
</p>