Import a credential
This endpoint imports a credential into your account.
You’ll import a credential in the event that you’ve authenticated a user with a provider outside of Sequin. For example, you might have your users authenticate to Stripe via an OAuth flow you control. You can then import that credential into Sequin.
Importing a credential is an idempotent operation. Sequin upserts credentials. So, if you attempt to import a credential for an existing Salesforce account, only one credential will be created.
Request parameters
A name for your credential.
The credential properties for the provider.
The properties
parameter depend on the kind
of credential you’re importing. See the list of possible values.
OAuth app to associate with the credential. Learn more about the OAuth app object.
Note that this OAuth app must have the same client_id
and client_secret
that you used to originally obtain the credential.
Metadata for the credential. This is a free-form object that you can use to store any additional information you want to associate with the credential.
Response fields
ID of the credential.
Provider of the credential (e.g. github
, stripe
, etc). See the list of possible values.
Kind of credential (e.g. stripe_oauth
, github
, etc). See the list of possible values.
Status of the credential. Learn more about the health object.
OAuth app associated to the credential. Learn more about the OAuth app object.
The properties for the credential. This field is polymorphic based on the credential kind. Learn more about credential properties.
Metadata for the credential. This is a free-form object that you can use to store any additional information you want to associate with the credential.
Timestamp of when the credential was created, in ISO 8601 format.
Timestamp of when the credential was last updated, in ISO 8601 format.
Was this page helpful?