Skip to content

Interface: BaseAuthentication

core.BaseAuthentication

Base interface for authentication definitions.

Hierarchy

  • BaseAuthentication

AWSAccessKeyAuthentication

AWSAssumeRoleAuthentication

CodaApiBearerTokenAuthentication

CustomAuthentication

CustomHeaderTokenAuthentication

HeaderBearerTokenAuthentication

MultiQueryParamTokenAuthentication

OAuth2Authentication

QueryParamTokenAuthentication

WebBasicAuthentication

Properties

endpointDomain

Optional endpointDomain: string

When requiresEndpointUrl is set to true this should be the root domain that all endpoints share. For example, this value would be "example.com" if specific endpoints looked like {custom-subdomain}.example.com.

For packs that make requests to multiple domains (uncommon), this should be the domain within networkDomains that this configuration applies to.

Defined in

types.ts:247


getConnectionName

Optional getConnectionName: MetadataFormula

A function that is called when a user sets up a new account, that returns a name for the account to label that account in the UI. The users credentials are applied to any fetcher requests that this function makes. Typically, this function makes an API call to an API's "who am I" endpoint and returns a username.

If omitted, or if the function returns an empty value, the account will be labeled with the creating user's Coda username.

Defined in

types.ts:215


instructionsUrl

Optional instructionsUrl: string

A link to a help article or other page with more instructions about how to set up an account for this pack.

Defined in

types.ts:230


networkDomain

Optional networkDomain: string | string[]

Which domain(s) should get auth credentials, when a pack is configured with multiple domains. Packs configured with only one domain or with requiredsEndpointUrl set to true can omit this.

Using multiple authenticated network domains is uncommon and requires Coda approval.

Defined in

types.ts:261


postSetup

Optional postSetup: SetEndpoint[]

One or more setup steps to run after the user has set up the account, before completing installation of the pack. This is not common.

Defined in

types.ts:253


requiresEndpointUrl

Optional requiresEndpointUrl: boolean

If true, indicates this has pack has a specific endpoint domain for each account, that is used as the basis of HTTP requests. For example, API requests are made to .example.com rather than example.com. If true, the user will be prompted to provide their specific endpoint domain when creating a new account.

Defined in

types.ts:238