Appearance
@line/bot-sdk / Exports / channelAccessToken
Namespace: channelAccessToken
Table of contents
Classes
Type Aliases
- ChannelAccessTokenKeyIdsResponse
- ErrorResponse
- IssueChannelAccessTokenResponse
- IssueShortLivedChannelAccessTokenResponse
- IssueStatelessChannelAccessTokenResponse
- VerifyChannelAccessTokenResponse
Type Aliases
ChannelAccessTokenKeyIdsResponse
Ƭ ChannelAccessTokenKeyIdsResponse: Object
Channel access token key IDs
Type declaration
Name | Type | Description |
---|---|---|
kids | string [] | Array of channel access token key IDs. See kids Documentation |
Defined in
lib/channel-access-token/model/channelAccessTokenKeyIdsResponse.ts:16
ErrorResponse
Ƭ ErrorResponse: Object
Error response of the Channel access token
Type declaration
Name | Type | Description |
---|---|---|
error? | string | Error summary |
errorDescription? | string | Details of the error. Not returned in certain situations. |
Defined in
lib/channel-access-token/model/errorResponse.ts:16
IssueChannelAccessTokenResponse
Ƭ IssueChannelAccessTokenResponse: Object
Issued channel access token
Type declaration
Name | Type | Description |
---|---|---|
accessToken | string | Channel access token. See accessToken Documentation |
expiresIn | number | Amount of time in seconds from issue to expiration of the channel access token See expiresIn Documentation |
keyId | string | Unique key ID for identifying the channel access token. See keyId Documentation |
tokenType | string | A token type. See tokenType Documentation |
Defined in
lib/channel-access-token/model/issueChannelAccessTokenResponse.ts:16
IssueShortLivedChannelAccessTokenResponse
Ƭ IssueShortLivedChannelAccessTokenResponse: Object
Issued short-lived channel access token
Type declaration
Name | Type | Description |
---|---|---|
accessToken | string | A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed. See accessToken Documentation |
expiresIn | number | Time until channel access token expires in seconds from time the token is issued. See expiresIn Documentation |
tokenType | string | Token type. The value is always Bearer . See tokenType Documentation |
Defined in
lib/channel-access-token/model/issueShortLivedChannelAccessTokenResponse.ts:16
IssueStatelessChannelAccessTokenResponse
Ƭ IssueStatelessChannelAccessTokenResponse: Object
Issued stateless channel access token
Type declaration
Name | Type | Description |
---|---|---|
accessToken | string | A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token. See accessToken Documentation |
expiresIn | number | Duration in seconds after which the issued access token expires See expiresIn Documentation |
tokenType | string | Token type. The value is always Bearer . See tokenType Documentation |
Defined in
lib/channel-access-token/model/issueStatelessChannelAccessTokenResponse.ts:16
VerifyChannelAccessTokenResponse
Ƭ VerifyChannelAccessTokenResponse: Object
Verification result
Type declaration
Name | Type | Description |
---|---|---|
clientId | string | The channel ID for which the channel access token was issued. |
expiresIn | number | Number of seconds before the channel access token expires. |
scope? | string | Permissions granted to the channel access token. |
Defined in
lib/channel-access-token/model/verifyChannelAccessTokenResponse.ts:16