POST
/
environments
/
{environmentId}
/
settings
/
providers
Authorization
Path
Body
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/settings/providers \
  --header 'Content-Type: application/json' \
  --data '{
  "appleKeyId": "<string>",
  "appleTeamId": "<string>",
  "clientId": "<string>",
  "clientSecret": "<string>",
  "defaultChainId": 123,
  "keyExportUrl": "<string>",
  "provider": "emailOnly",
  "providerProjectId": "<string>",
  "termsUrl": "<string>"
}'
{
  "appleKeyId": "<string>",
  "appleTeamId": "<string>",
  "authorizationUrl": "<string>",
  "clientId": "<string>",
  "clientSecret": "<string>",
  "defaultChainId": 123,
  "enabledAt": "2023-11-07T05:31:56Z",
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "keyExportUrl": "<string>",
  "provider": "emailOnly",
  "providerProjectId": "<string>",
  "redirectUrl": "<string>",
  "termsAcceptedByUser": {
    "createdAt": "2023-11-07T05:31:56Z",
    "email": "jsmith@example.com",
    "termsUrl": "<string>",
    "userId": "95b11417-f18f-457f-8804-68e361f9164f"
  }
}

Path Parameters

environmentId
string
required

ID of the environment

Body

application/json
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.

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/

defaultChainId
integer

The default chain id the SDK should use

keyExportUrl
string

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

provider
enum<string>
required
Available options:
emailOnly,
magicLink,
apple,
bitbucket,
discord,
facebook,
github,
gitlab,
google,
instagram,
linkedin,
microsoft,
twitch,
twitter,
blocto,
banxa,
dynamic,
alchemy,
zerodev,
turnkey
providerProjectId
string

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

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.

Response

201 - application/json
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.

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

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/

defaultChainId
integer

The default chain id the SDK should use

enabledAt
string | null
id
string
keyExportUrl
string

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

provider
enum<string>
required
Available options:
emailOnly,
magicLink,
apple,
bitbucket,
discord,
facebook,
github,
gitlab,
google,
instagram,
linkedin,
microsoft,
twitch,
twitter,
blocto,
banxa,
dynamic,
alchemy,
zerodev,
turnkey
providerProjectId
string

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

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

termsAcceptedByUser
object

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

Was this page helpful?

Updates the configs for the sdk view and project environmentGet the URLs for the environment providers