Enumeration: AuthenticationType¶
Defined in: types.ts:41
Authentication types supported by Coda Packs.
See¶
Enumeration Members¶
AWSAccessKey¶
AWSAccessKey:
"AWSAccessKey"
Defined in: types.ts:113
Authenticate to Amazon Web Services using an IAM access key id & secret access key pair.
See¶
AWSAssumeRole¶
AWSAssumeRole:
"AWSAssumeRole"
Defined in: types.ts:119
Authenticate to Amazon Web Services by assuming an IAM role.
See¶
CodaApiHeaderBearerToken¶
CodaApiHeaderBearerToken:
"CodaApiHeaderBearerToken"
Defined in: types.ts:125
Authenticate using a Coda REST API token, sent as an HTTP header.
See¶
CodaApiBearerTokenAuthentication
Custom¶
Custom:
"Custom"
Defined in: types.ts:107
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¶
CustomHeaderToken¶
CustomHeaderToken:
"CustomHeaderToken"
Defined in: types.ts:57
Authenticate using an HTTP header with a custom name and token prefix that you specify.
See¶
CustomHeaderTokenAuthentication
HeaderBearerToken¶
HeaderBearerToken:
"HeaderBearerToken"
Defined in: types.ts:51
Authenticate using an HTTP header of the form Authorization: Bearer <token>.
See¶
HeaderBearerTokenAuthentication
MultiHeaderToken¶
MultiHeaderToken:
"MultiHeaderToken"
Defined in: types.ts:63
Authenticate using multiple HTTP headers that you specify.
See¶
MultiHeaderTokenAuthentication
MultiQueryParamToken¶
MultiQueryParamToken:
"MultiQueryParamToken"
Defined in: types.ts:77
Authenticate using multiple tokens, each passed as a different URL parameter, e.g.
https://example.com/api?param1=token1¶m2=token2
See¶
MultiQueryParamTokenAuthentication
None¶
None:
"None"
Defined in: types.ts:45
Indicates this pack does not use authentication. You may also omit an authentication declaration entirely.
OAuth2¶
OAuth2:
"OAuth2"
Defined in: types.ts:85
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¶
OAuth2ClientCredentials¶
OAuth2ClientCredentials:
"OAuth2ClientCredentials"
Defined in: types.ts:93
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¶
QueryParamToken¶
QueryParamToken:
"QueryParamToken"
Defined in: types.ts:70
Authenticate using a token that is passed as a URL parameter with each request, e.g.
https://example.com/api?paramName=token.
See¶
WebBasic¶
WebBasic:
"WebBasic"
Defined in: types.ts:100
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.