Interface: CodaApiBearerTokenAuthentication¶
Authenticate using a Coda REST API token, sent as an HTTP header.
This is identical to HeaderBearerToken except the user wil be presented with a UI to generate an API token rather than needing to paste an arbitrary API token into a text input.
This is primarily for use by Coda-authored packs, as it is only relevant for interacting with the Coda REST API.
Hierarchy¶
↳ CodaApiBearerTokenAuthentication
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¶
deferConnectionSetup¶
• Optional deferConnectionSetup: boolean
If true, does not require a connection to be configured in order to install the pack.
Defined in¶
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¶
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¶
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¶
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¶
Defined in¶
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
Inherited from¶
BaseAuthentication.requiresEndpointUrl
Defined in¶
shouldAutoAuthSetup¶
• Optional shouldAutoAuthSetup: boolean
If true, automatically creates and configures an account with a Coda API token with default settings when installing the pack: a scoped read-write token, added to the doc as a shared account that allows actions.
Defined in¶
type¶
• type: CodaApiHeaderBearerToken
Identifies this as CodaApiHeaderBearerToken authentication.