POST
/
environments
/
{environmentId}
/
settings
/
providers

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36

Body

application/json

Request body to create a new provider. The provider will be not enabled by default.

provider
enum<string>
required
Available options:
emailOnly,
magicLink,
apple,
bitbucket,
coinbasesocial,
discord,
epicgames,
facebook,
farcaster,
github,
gitlab,
google,
instagram,
linkedin,
microsoft,
twitch,
twitter,
blocto,
banxa,
dynamic,
alchemy,
zerodev,
telegram,
turnkey,
coinbaseWaas,
sms,
spotify,
tiktok,
line,
steam,
shopify
clientId
string

Standard OAuth client ID. For more information, see: https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/. For Apple, this is also known as the Service ID.

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
keyExportUrl
string

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

termsUrl
string

The url of the terms and conditions or privacy policy needed to be shown to the client when creating a new provider that requires terms and conditions to be signed before starting configuration.

useDynamicCredentials
boolean
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.

accountSid
string

Required to initialize Twilio provider.

twilioNumber
string

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

enabledCountries
object[]
multichainAccountAbstractionProviders
object[]
entryPointVersion
enum<string>
Available options:
v6,
v7
kernelVersion
enum<string>
Available options:
v2_4,
v3_0,
v3_1
ecdsaProviderType
enum<string>
Available options:
zerodev_signer_to_ecdsa,
zerodev_multi_chain

Response

201 - application/json
provider
enum<string>
required
Available options:
emailOnly,
magicLink,
apple,
bitbucket,
coinbasesocial,
discord,
epicgames,
facebook,
farcaster,
github,
gitlab,
google,
instagram,
linkedin,
microsoft,
twitch,
twitter,
blocto,
banxa,
dynamic,
alchemy,
zerodev,
telegram,
turnkey,
coinbaseWaas,
sms,
spotify,
tiktok,
line,
steam,
shopify
id
string
Required string length: 36
enabledAt
string | null
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
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.

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.

accountSid
string

Required to initialize Twilio provider.

twilioNumber
string

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

enabledCountries
object[]
entryPointVersion
enum<string>
Available options:
v6,
v7
kernelVersion
enum<string>
Available options:
v2_4,
v3_0,
v3_1
multichainAccountAbstractionProviders
object[]
ecdsaProviderType
enum<string>
Available options:
zerodev_signer_to_ecdsa,
zerodev_multi_chain
createNewAccounts
boolean