Skip to main content
Run a login workflow in the context of the current page. Supports multiple credential providers.

​
Parameters

Parameter (Python)Parameter (TS)TypeRequiredDefaultDescription
credential_typefirst positional argCredentialType / stringYes-Provider type: skyvern, bitwarden, onepassword, azure_vault.
urlurlstr / stringNoNone / undefinedURL to navigate to before logging in.
credential_idcredentialIdstr / stringNoNone / undefinedSkyvern credential ID. Required when credential_type is skyvern.
promptpromptstr / stringNoNone / undefinedAdditional natural-language login instructions.
webhook_urlwebhookUrlstr / stringNoNone / undefinedURL to receive a callback when login completes.
totp_identifiertotpIdentifierstr / stringNoNone / undefinedIdentifier for TOTP-based two-factor authentication.
totp_urltotpUrlstr / stringNoNone / undefinedURL for TOTP secret retrieval.
extra_http_headersextraHttpHeadersdict / objectNoNone / undefinedAdditional HTTP headers to set on the browser context.
timeouttimeoutfloat / numberNo1800Maximum time in seconds to wait for login to complete.
Provider-specific parameters (bitwarden_item_id, onepassword_vault_id, etc.) are required based on the credential_type chosen. See the examples below for each provider.

​
Examples

from skyvern.schemas.run_blocks import CredentialType

# Skyvern credentials
await page.agent.login(
    credential_type=CredentialType.skyvern,
    credential_id="cred_123",
)

# Bitwarden
await page.agent.login(
    credential_type=CredentialType.bitwarden,
    bitwarden_item_id="item_id",
    bitwarden_collection_id="collection_id",
)

# 1Password
await page.agent.login(
    credential_type=CredentialType.onepassword,
    onepassword_vault_id="vault_id",
    onepassword_item_id="item_id",
)

# Azure Vault
await page.agent.login(
    credential_type=CredentialType.azure_vault,
    azure_vault_name="vault_name",
    azure_vault_username_key="username_key",
    azure_vault_password_key="password_key",
)
Returns WorkflowRunResponse.