Create

Create a new external integration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Some integration types support keyless authentication, where Doppler authenticates with a short-lived OIDC token instead of a stored credential. For those types, authMethod selects the mode and determines which other fields are required. See Keyless Authentication for how the trust relationship is established.

Keyless connections are created without their access being verified, since the identity they authenticate as contains the connection ID that this request returns. Grant that identity access in your cloud after creating the connection, using the federation object on the Retrieve response.

AWS Secrets Manager and Parameter Store

Type: aws_secrets_manager or aws_parameter_store

Data Object

FieldTypeDescription
aws_assume_role_arnstringThe ARN of the AWS role that Doppler should use to assume into your AWS account. See docs for configuration details.

Azure Vault (Service Principal)

Type: azure_vault_service_principal

Data Object

FieldTypeDescription
client_idstringThe Service Principal Client ID. See docs for details.
client_secretstringThe Service Principal Client Secret. See docs for details.
tenant_idstringThe Service Principal Tenant ID. See docs for details.

Azure Service Principal (Rotated and Dynamic)

Type: azure_rotated_service_principal or azure_dynamic_service_principal

These types support keyless authentication. See docs for setup details.

Data Object

FieldTypeDescription
authMethodstringoidc for keyless authentication or clientSecret. Defaults to clientSecret when omitted.
clientIdstringThe Application (Client) ID of the managing Service Principal.
tenantIdstringThe Directory (Tenant) ID of the managing Service Principal.
clientSecretstringThe managing Service Principal's client secret value. Required when authMethod is clientSecret, rejected when it's oidc.

CircleCI

Type: circleci

Data Object

FieldTypeDescription
api_tokenstringA CircleCI API token. See docs for setup details.

Fly.io

Type: flyio

Data Object

FieldTypeDescription
api_keystringA Fly.io API key. See docs for setup details.

GCP Cloud SQL

Type: gcp_cloudsql_mysql, gcp_cloudsql_postgres, or gcp_cloudsql_sqlserver

These types support keyless authentication. See docs for setup details.

Data Object

FieldTypeDescription
authMethodstringoidc for keyless authentication or key. Defaults to key when omitted.
gcpKeyobjectThe IAM Service Account JSON key. Required when authMethod is key.
gcp_workload_identity_providerstringThe full resource name of the workload identity provider, beginning with //iam.googleapis.com/. Required when authMethod is oidc.
gcp_project_idstringThe GCP project ID. Required when authMethod is oidc.

Supplying both gcpKey and gcp_workload_identity_provider is rejected.

GCP Secret Manager

Type: gcp_secret_manager

This type supports keyless authentication. See docs for setup details.

Data Object

FieldTypeDescription
authMethodstringoidc for keyless authentication or key. Defaults to key when omitted.
gcp_keyobjectThe IAM Service Account JSON key. Required when authMethod is key. See docs for details.
gcp_workload_identity_providerstringThe full resource name of the workload identity provider, beginning with //iam.googleapis.com/. Required when authMethod is oidc.
gcp_project_idstringThe GCP project ID. Required when authMethod is oidc.
gcp_secret_prefixstringThe prefix added to any secret created by this integration in GCP. See docs for details.

Supplying both gcp_key and gcp_workload_identity_provider is rejected.

Terraform Cloud

Type: terraform_cloud

Data Object

FieldTypeDescription
api_keystringA Terraform Cloud API key. See docs for setup details.
Body Params
string
required

The integration type

string
required

The name of the integration

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json