DYdynamic
Settings

Enable the provider for the environment

put/settings/providers/{providerId}/enable

Request

  • Base URL
    https://app.dynamicauth.com/api/v0
  • Auth
    HTTP bearer

Path parameters

providerIdstring required
Example:95b11417-f18f-457f-8804-68e361f9164f

ID of the provider

Response

Successful

idstring
provider'emailOnly' | 'magicLink' | 'apple' | 'bitbucket' | 'coinbasesocial' | 'discord' | 'epicgames' | 'facebook' | 'farcaster' | 'github' | 'gitlab' | 'google' | 'instagram' | 'linkedin' | 'microsoft' | 'twitch' | 'twitter' | 'blocto' | 'banxa' | 'coinbaseOnramp' | 'cryptoDotCom' | 'dynamic' | 'alchemy' | 'zerodev' | 'telegram' | 'turnkey' | 'coinbaseWaas' | 'sms' | 'spotify' | 'tiktok' | 'line' | 'steam' | 'shopify' | 'zksync' | 'kraken' | 'blockaid' | 'passkey' | 'okta' | 'sendgrid' | 'resend' required

The 'turnkey' value is deprecated and will be removed in a future version.

enabledAtstring date-time nullable
clientIdstring

Standard OAuth client ID. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/

clientSecretstring

Standard OAuth client secret key. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/

providerProjectIdstring

Some providers require additional information, typically called a project ID or site ID

authorizationUrlstring

If the provider supports Oauth 2, this field will contain the URL of the login and authorization where a user can authorize the applciation to gain access to their provider account

redirectUrlstring

If the provider supports Oauth 2, this field will contain the URL of redirect or callback URL which will need to be provided to the Oauth provider to properly configure your App tp talk with Dynamic

defaultChainIdinteger

DEPRECATED: Use defaultChain. The default chain id the SDK should use

defaultChainstring

CAIP-2 Chain ID (https://github.com/ChainAgnostic/CAIPs/blob/main/CAIPs/caip-2.md)

keyExportUrlstring

The url of the site to go to export wallets private keys

scopesstring

Optional custom space-delimited list of Oauth scopes for the social provider

baseAuthUrlstring

Base auth url for oauth provider

appleKeyIdstring

Key ID required for Apple Oauth2 applications. This is the identifier for a private key.

appleTeamIdstring

Team ID required for Apple Oauth2 applications. This is associated with the Apple developer membership account.

shopifyStorestring

Shopify store required for Shopify Oauth2 applications.

domainstring

The subdomain for the provider (mostly used for SSO)

accountSidstring

Required to initialize Twilio provider.

twilioNumberstring

Required to initialize Twilio provider. Phone number used to send SMS messages.

twilioVerifyServiceSidstring

Twilio Verify Service SID for SMS verification.

sendgridIpPoolNamestring

The IP pool name for the SendGrid provider.

entryPointVersion'v6' | 'v7'
kernelVersion'v2_4' | 'v3_0' | 'v3_1' | 'v3_2' | 'v3_3'
factoryAddressstring

The factory address for the provider (currently only used for zksync)

paymasterAddressstring

The paymaster address for the provider (currently only used for zksync)

passkeyAddressstring

The passkey address for the provider (currently only used for zksync)

sessionAddressstring

The session address for the provider (currently only used for zksync)

saltstring

The salt for the provider address generation (currently only used for zksync)

ecdsaProviderType'zerodev_signer_to_ecdsa' | 'zerodev_multi_chain'
createNewAccountsboolean
enableKernelV3Migrationboolean
enableEIP7702boolean
zerodevBundlerProvider'STACKUP' | 'PIMLICO' | 'ALCHEMY' | 'GELATO'
zerodevBundlerRpcUrlstring
zerodevPaymasterRpcUrlstring
zerodevKernelDelegationAddressstring
returnUrlstring

URL to return to after completion

cancelUrlstring

URL to return to when cancelled

Example response

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "defaultChain": "eip155:1",
  "termsAcceptedByUser": {
    "userId": "95b11417-f18f-457f-8804-68e361f9164f"
  },
  "enabledCountries": [
    {
      "isoCountryCode": "US",
      "phoneCountryCode": "An example name"
    }
  ]
}

Changes

No recorded changes to this operation across all 5 revisions of this API.