Enumeration: AuthenticationType

core.AuthenticationType

Authentication types supported by Coda Packs.

See

• Authenticating with other services
• Authentication samples

Enumeration Members

AWSAccessKey

• AWSAccessKey = "AWSAccessKey"

Authenticate to Amazon Web Services using an IAM access key id & secret access key pair.

See

AWSAccessKeyAuthentication

Defined in

types.ts:113

---

CodaApiHeaderBearerToken

• CodaApiHeaderBearerToken = "CodaApiHeaderBearerToken"

Authenticate using a Coda REST API token, sent as an HTTP header.

See

CodaApiBearerTokenAuthentication

Defined in

types.ts:126

---

Custom

• Custom = "Custom"

Authenticate in a custom way by having one or more arbitrary secret values inserted into the request URL, body, headers, or the form data using template replacement. Approval from Coda is required.

See

CustomAuthentication

Defined in

types.ts:107

---

CustomHeaderToken

• CustomHeaderToken = "CustomHeaderToken"

Authenticate using an HTTP header with a custom name and token prefix that you specify.

See

CustomHeaderTokenAuthentication

Defined in

types.ts:57

---

HeaderBearerToken

• HeaderBearerToken = "HeaderBearerToken"

Authenticate using an HTTP header of the form Authorization: Bearer <token>.

See

HeaderBearerTokenAuthentication

Defined in

types.ts:51

---

MultiHeaderToken

• MultiHeaderToken = "MultiHeaderToken"

Authenticate using multiple HTTP headers that you specify.

See

MultiHeaderTokenAuthentication

Defined in

types.ts:63

---

MultiQueryParamToken

• MultiQueryParamToken = "MultiQueryParamToken"

Authenticate using multiple tokens, each passed as a different URL parameter, e.g. https://example.com/api?param1=token1&param2=token2

See

MultiQueryParamTokenAuthentication

Defined in

types.ts:77

---

None

• None = "None"

Indicates this pack does not use authentication. You may also omit an authentication declaration entirely.

Defined in

types.ts:45

---

OAuth2

• OAuth2 = "OAuth2"

Authenticate using OAuth2. This is the most common type of OAuth2, which involves the user approving access to their account before being granted a token. The API must use a (largely) standards-compliant implementation of OAuth2.

See

OAuth2Authentication

Defined in

types.ts:85

---

OAuth2ClientCredentials

• OAuth2ClientCredentials = "OAuth2ClientCredentials"

Authenticate using OAuth2 client credentials. This is a less common type of OAuth2, which involves exchanging a client ID and secret for a temporary access token.

See

• OAuth2 client credentials spec
• OAuth2ClientCredentials

Defined in

types.ts:93

---

QueryParamToken

• QueryParamToken = "QueryParamToken"

Authenticate using a token that is passed as a URL parameter with each request, e.g. https://example.com/api?paramName=token.

See

QueryParamTokenAuthentication

Defined in

types.ts:70

---

WebBasic

• WebBasic = "WebBasic"

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

WebBasicAuthentication

Defined in

types.ts:100