Interface: WebBasicAuthentication¶

Authenticate using HTTP Basic authorization. The user provides a username and password (sometimes optional) which are included as an HTTP header according to the Basic auth standard.

See https://en.wikipedia.org/wiki/Basic_access_authentication

Hierarchy¶

BaseAuthentication

↳ WebBasicAuthentication

Properties¶

defaultConnectionType¶

• Optional defaultConnectionType: DefaultConnectionType

Indicates the default manner in which a user's account is expected to be used by this pack, e.g. is this account used for retrieving data, taking actions, or both. See https://help.coda.io/en/articles/4587167-what-can-coda-access-with-packs#h_40472431f0

Inherited from¶

BaseAuthentication.defaultConnectionType

Defined in¶

types.ts:251

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.

Inherited from¶

BaseAuthentication.endpointDomain

Defined in¶

types.ts:273

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.

Inherited from¶

BaseAuthentication.getConnectionName

Defined in¶

types.ts:234

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.

Inherited from¶

BaseAuthentication.instructionsUrl

Defined in¶

types.ts:256

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.

Inherited from¶

BaseAuthentication.postSetup

Defined in¶

types.ts:279

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.

Inherited from¶

BaseAuthentication.requiresEndpointUrl

Defined in¶

types.ts:264

type¶

• type: WebBasic

Identifies this as WebBasic authentication.

Defined in¶

types.ts:452

uxConfig¶

• Optional uxConfig: Object

Configuration for labels to show in the UI when the user sets up a new acount.

Type declaration¶

Name	Type	Description
`placeholderPassword?`	`string`	A placeholder value for the text input where the user will enter a password.
`placeholderUsername?`	`string`	A placeholder value for the text input where the user will enter a username.
`usernameOnly?`	`boolean`	If true, only a username input will be shown to the user. Some services pass API keys in the username field and do not require a password.

Defined in¶

types.ts:456