Updates a provider

Updates the configuration of the specified provider.

PUT /settings/providers/{providerId}

Updates a provider

cURL

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/settings/providers/{providerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "<string>",
  "clientSecret": "<string>",
  "providerProjectId": "<string>",
  "defaultChainId": 123,
  "defaultChain": "eip155:1",
  "keyExportUrl": "<string>",
  "useDynamicCredentials": true,
  "scopes": "<string>",
  "appleKeyId": "<string>",
  "appleTeamId": "<string>",
  "shopifyStore": "<string>",
  "domain": "<string>",
  "accountSid": "<string>",
  "twilioNumber": "<string>",
  "twilioVerifyServiceSid": "<string>",
  "enabledCountries": [
    {
      "isoCountryCode": "US",
      "phoneCountryCode": "An example name"
    }
  ],
  "sendgridIpPoolName": "<string>",
  "multichainAccountAbstractionProviders": [
    {
      "clientId": "<string>",
      "chain": "<string>",
      "default": true
    }
  ],
  "entryPointVersion": "v6",
  "kernelVersion": "v2_4",
  "ecdsaProviderType": "zerodev_signer_to_ecdsa",
  "enableKernelV3Migration": true,
  "enableEIP7702": true,
  "factoryAddress": "<string>",
  "paymasterAddress": "<string>",
  "passkeyAddress": "<string>",
  "sessionAddress": "<string>",
  "zerodevBundlerProvider": "STACKUP",
  "zerodevBundlerRpcUrl": "<string>",
  "zerodevPaymasterRpcUrl": "<string>",
  "zerodevKernelDelegationAddress": "<string>",
  "zerodevProjectVersion": "<string>",
  "returnUrl": "<string>",
  "cancelUrl": "<string>"
}
'

200

{
  "provider": "emailOnly",
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "enabledAt": "2023-11-07T05:31:56Z",
  "clientId": "<string>",
  "clientSecret": "<string>",
  "providerProjectId": "<string>",
  "authorizationUrl": "<string>",
  "redirectUrl": "<string>",
  "defaultChainId": 123,
  "defaultChain": "eip155:1",
  "keyExportUrl": "<string>",
  "termsAcceptedByUser": {
    "termsUrl": "<string>",
    "email": "[e-mail]",
    "userId": "95b11417-f18f-457f-8804-68e361f9164f",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "scopes": "<string>",
  "baseAuthUrl": "<string>",
  "appleKeyId": "<string>",
  "appleTeamId": "<string>",
  "shopifyStore": "<string>",
  "domain": "<string>",
  "accountSid": "<string>",
  "twilioNumber": "<string>",
  "twilioVerifyServiceSid": "<string>",
  "enabledCountries": [
    {
      "isoCountryCode": "US",
      "phoneCountryCode": "An example name"
    }
  ],
  "sendgridIpPoolName": "<string>",
  "entryPointVersion": "v6",
  "kernelVersion": "v2_4",
  "factoryAddress": "<string>",
  "paymasterAddress": "<string>",
  "passkeyAddress": "<string>",
  "sessionAddress": "<string>",
  "salt": "<string>",
  "multichainAccountAbstractionProviders": [
    {
      "clientId": "<string>",
      "chain": "<string>",
      "default": true
    }
  ],
  "ecdsaProviderType": "zerodev_signer_to_ecdsa",
  "createNewAccounts": true,
  "enableKernelV3Migration": true,
  "enableEIP7702": true,
  "zerodevBundlerProvider": "STACKUP",
  "zerodevBundlerRpcUrl": "<string>",
  "zerodevPaymasterRpcUrl": "<string>",
  "zerodevKernelDelegationAddress": "<string>",
  "zerodevProjectVersion": "<string>",
  "returnUrl": "<string>",
  "cancelUrl": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

providerId · string · required

ID of the provider

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Request body to update oauth properties and other metadata about a provider.

clientId · string

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

clientSecret · string

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

providerProjectId · string

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

defaultChainId · integer

The default chain id the SDK should use

defaultChain · string

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

Required string length: 5 - 41

Pattern: ^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$

Example:

"eip155:1"

keyExportUrl · string

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

useDynamicCredentials · boolean

When true, Dynamic manages the OAuth credentials — clientId and clientSecret are set to null

scopes · string

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

appleKeyId · string

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

appleTeamId · string

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

shopifyStore · string

Shopify store required for Shopify Oauth2 applications.

domain · string

The subdomain for the provider (mostly used for SSO)

accountSid · string

Required to initialize Twilio provider.

twilioNumber · string

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

twilioVerifyServiceSid · string

Twilio Verify Service SID for SMS verification.

enabledCountries · object[]

ISO country codes restricting which countries can use this SMS provider

Show child attributes

sendgridIpPoolName · string

The IP pool name for the SendGrid provider.

multichainAccountAbstractionProviders · object[]

ZeroDev account abstraction chain mappings — each entry binds a clientId to a specific chain

Show child attributes

entryPointVersion · enum<string>

Available options: v6, v7

kernelVersion · enum<string>

Available options: v2_4, v3_0, v3_1, v3_2, v3_3

ecdsaProviderType · enum<string>

Available options: zerodev_signer_to_ecdsa, zerodev_multi_chain

enableKernelV3Migration · boolean

When true, migrates existing user smart accounts from Kernel v2 to v3 on next interaction

enableEIP7702 · boolean

When true, enables EIP-7702 set-code transactions for cheaper account abstraction deployment

factoryAddress · string

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

paymasterAddress · string

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

passkeyAddress · string

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

sessionAddress · string

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

zerodevBundlerProvider · enum<string>

Available options: STACKUP, PIMLICO, ALCHEMY, GELATO

zerodevBundlerRpcUrl · string

Custom RPC endpoint URL overriding the default ZeroDev bundler for UserOperation submission

zerodevPaymasterRpcUrl · string

Custom RPC endpoint URL for the paymaster service that sponsors gas fees for users

zerodevKernelDelegationAddress · string

Kernel smart contract address enabling delegated account control for multi-sig or recovery

zerodevProjectVersion · string

The ZeroDev projects endpoint version (v1 or v2)

returnUrl · string

URL to return to after completion

cancelUrl · string

URL to return to when cancelled

Response

200

application/json

Successful

provider · enum<string> · required

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

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

id · string

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

enabledAt · string<date-time> | null

ISO 8601 timestamp of when this provider was enabled

clientId · string

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

clientSecret · string

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

providerProjectId · string

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

authorizationUrl · string

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

redirectUrl · string

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

defaultChainId · integer

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

defaultChain · string

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

Required string length: 5 - 41

Pattern: ^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$

Example:

"eip155:1"

keyExportUrl · string

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

termsAcceptedByUser · object

Reference to the user that accepted the terms and conditions, if one is necessary for this provider.

Show child attributes

scopes · string

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

baseAuthUrl · string

Base auth url for oauth provider

appleKeyId · string

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

appleTeamId · string

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

shopifyStore · string

Shopify store required for Shopify Oauth2 applications.

domain · string

The subdomain for the provider (mostly used for SSO)

accountSid · string

Required to initialize Twilio provider.

twilioNumber · string

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

twilioVerifyServiceSid · string

Twilio Verify Service SID for SMS verification.

enabledCountries · object[]

Show child attributes

sendgridIpPoolName · string

The IP pool name for the SendGrid provider.

entryPointVersion · enum<string>

Available options: v6, v7

kernelVersion · enum<string>

Available options: v2_4, v3_0, v3_1, v3_2, v3_3

factoryAddress · string

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

paymasterAddress · string

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

passkeyAddress · string

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

sessionAddress · string

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

salt · string

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

multichainAccountAbstractionProviders · object[]

Show child attributes

ecdsaProviderType · enum<string>

Available options: zerodev_signer_to_ecdsa, zerodev_multi_chain

createNewAccounts · boolean

Whether this provider automatically creates new accounts on first login

enableKernelV3Migration · boolean

enableEIP7702 · boolean

zerodevBundlerProvider · enum<string>

Available options: STACKUP, PIMLICO, ALCHEMY, GELATO

zerodevBundlerRpcUrl · string

zerodevPaymasterRpcUrl · string

zerodevKernelDelegationAddress · string

zerodevProjectVersion · string

The ZeroDev projects endpoint version (v1 or v2)

returnUrl · string

URL to return to after completion

cancelUrl · string

URL to return to when cancelled