Interface NextIdentityCognito<T>

class: NextIdentityCognito

  • extended information w/ cognito identity.

Type Parameters

  • T = any

Hierarchy

Properties

accessKey? accountId apiKey? caller? error? gid? identityId identityPoolId identityProvider? lang? meta? roles? sid? uid? userAgent?

Properties

Optional accessKey

accessKey?: string

(optional) access-key used to sign.

accountId

accountId: string

account-id of AWS Credential

Optional apiKey

apiKey?: string

(optional) api-key if applicable.

Optional caller

caller?: string

(optional) caller string like AROXXXXXX:CognitoIdentityCredentials from APIGatewayEventIdentity

  • available since 3.1.1

Optional error

error?: string

(optional) internal last-error message

  • if this is not empty, then DO NOT use this object.

Since

ver3.1.2 2022/MAY/15

Optional gid

gid?: string

group-id (group id)

identityId

identityId: string

identity-id of cognito.

identityPoolId

identityPoolId: string

identity-pool-id of cognito

Optional identityProvider

identityProvider?: string

authenticated provider of cognito like 'oauth.lemoncloud.io,oauth.lemoncloud.io:ap-northeast-2:618ce9d2-1234-2345-4567-e248ea51425e:kakao_00000'

Optional lang

lang?: string

prefered language (like 'ko')

  • use x-lemon-language header, or in x-lemon-identity

Since

ver2.2.3 2020/JUL/15

Optional meta

meta?: T

something unknown having the original data.

Optional roles

roles?: string[]

roles (like user, admin, super)

Optional sid

sid?: string

site-id (like domain group)

Optional uid

uid?: string

user-id (user id)

Optional userAgent

userAgent?: string

user-agent string like 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4)'

Settings

Member Visibility

Theme

Generated using TypeDoc