Akan.js v2 docs are now available.View the v1 docs
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | |
|---|---|---|---|---|---|---|---|---|---|
id user.id | ID | Required | property | - | null | - | - | user.id.desc | |
createdAt user.createdAt | Date | Required | property | - | null | - | - | user.createdAt.desc | |
updatedAt user.updatedAt | Date | Required | property | - | null | - | - | user.updatedAt.desc | |
removedAt user.removedAt | Date | Optional | property | - | null | - | - | user.removedAt.desc | |
nickname user.nickname | String | Optional | property | - | maxlength 12 | - | user.nickname.desc | ||
image user.image | File | Optional | property | reference | null | - | - | user.image.desc | |
images user.images | [File] | Required | property | reference | [] | - | - | user.images.desc | |
appliedImages user.appliedImages | [File] | Required | property | reference | [] | - | - | user.appliedImages.desc | |
name user.name | String | Optional | hiddenselect:false | - | null | - | - | user.name.desc | |
agreePolicies user.agreePolicies | [String] | Optional | hiddenselect:false | - | [] | - | - | user.agreePolicies.desc | |
discord user.discord | Any | Optional | hiddenselect:false | - | {} | - | - | user.discord.desc | |
accountId user.accountId | String | Optional | hiddenselect:false | - | null | - | - | user.accountId.desc | |
password user.password | String | Optional | hiddenselect:false | - | null | - | - | user.password.desc | |
phone user.phone | String | Optional | hiddenselect:false | - | null | - | - | user.phone.desc | |
notiInfo user.notiInfo | NotiInfo | Optional | hiddenselect:false | - | null | - | - | user.notiInfo.desc | |
imageNum user.imageNum | Int | Optional | hiddenselect:false | - | 0 | - | - | user.imageNum.desc | |
encourageInfo user.encourageInfo | EncourageInfo | Optional | hiddenselect:false | - | [function] | - | - | user.encourageInfo.desc | |
restrictInfo user.restrictInfo | RestrictInfo | Optional | hiddenselect:false | - | null | - | - | user.restrictInfo.desc | |
leaveInfo user.leaveInfo | LeaveInfo | Optional | hiddenselect:false | - | null | - | - | user.leaveInfo.desc | |
verifies user.verifies | [String] | Required | property | - | [] | - | naverkakaogithubgoogleapplefacebookwalletpasswordphoneemail | user.verifies.desc | |
roles user.roles | [String] | Required | property | - | ["user"] | - | rootadminuserbusinessguest | user.roles.desc | |
playing user.playing | [String] | Required | property | - | [] | - | - | user.playing.desc | |
isOnline user.isOnline | Boolean | Required | property | - | true | - | - | user.isOnline.desc | |
lastLoginAt user.lastLoginAt | Date | Required | property | - | [function] | - | - | user.lastLoginAt.desc | |
joinAt user.joinAt | Date | Optional | property | - | null | - | - | user.joinAt.desc | |
profileStatus user.profileStatus | String | Required | property | - | prepare | - | activeprepareappliedapprovedreappliedfeaturedreservedrejected | user.profileStatus.desc | |
badgeCount user.badgeCount | Int | Required | property | - | 0 | - | - | user.badgeCount.desc | |
status user.status | String | Required | property | - | prepare | - | prepareactivedormantrestricted | user.status.desc |
| Key | Ref Name | Type | Values | Used By |
|---|---|---|---|---|
| adminRole | adminRole | String | - | |
| bannerStatus | bannerStatus | String | - | |
| bannerTarget | bannerTarget | String | - | |
| coordinateType | coordinateType | String | - | |
| fileStatus | fileStatus | String | - | |
| inquiry | inquiry | String | - | |
| journey | journey | String | - | |
| leaveType | leaveType | String | - | |
| linkType | linkType | String | - | |
| notificationType | notificationType | String | - | |
| notiLevel | notiLevel | String | - | |
| notiSetting | notiSetting | String | - | |
| periodType | periodType | String | - | |
| profileStatus | profileStatus | String | user.profileStatususer.profileStatususer.profileStatus | |
| responsive | responsive | String | - | |
| ssoType | ssoType | String | - | |
| summaryStatus | summaryStatus | String | - | |
| userRole | userRole | String | user.rolesuser.roles | |
| userStatus | userStatus | String | user.statususer.statususer.status | |
| verify | verify | String | user.verifiesuser.verifies |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | Detail |
|---|---|---|---|---|---|---|---|---|---|
nickname user.nickname | String | Optional | property | - | maxlength 12 | - | user.nickname.desc | - | |
image user.image | File | Optional | property | reference target: file | null | - | - | user.image.desc | - |
images user.images | [File] | Required | property | reference target: file | [] | - | - | user.images.desc | - |
appliedImages user.appliedImages | [File] | Required | property | reference target: file | [] | - | - | user.appliedImages.desc | - |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | Detail |
|---|---|---|---|---|---|---|---|---|---|
id user.id | ID | Required | property | - | null | - | - | user.id.desc | - |
createdAt user.createdAt | Date | Required | property | - | null | - | - | user.createdAt.desc | - |
updatedAt user.updatedAt | Date | Required | property | - | null | - | - | user.updatedAt.desc | - |
removedAt user.removedAt | Date | Optional | property | - | null | - | - | user.removedAt.desc | - |
nickname user.nickname | String | Optional | property | - | maxlength 12 | - | user.nickname.desc | - | |
image user.image | File | Optional | property | reference target: file | null | - | - | user.image.desc | - |
images user.images | [File] | Required | property | reference target: file | [] | - | - | user.images.desc | - |
appliedImages user.appliedImages | [File] | Required | property | reference target: file | [] | - | - | user.appliedImages.desc | - |
name user.name | String | Optional | hidden select:false | - | null | - | - | user.name.desc | - |
agreePolicies user.agreePolicies | [String] | Optional | hidden select:false | - | [] | - | - | user.agreePolicies.desc | - |
discord user.discord | Any | Optional | hidden select:false | - | {} | - | - | user.discord.desc | - |
accountId user.accountId | String | Optional | hidden select:false | - | null | - | - | user.accountId.desc | - |
password user.password | String | Optional | hidden select:false | - | null | - | - | user.password.desc | - |
phone user.phone | String | Optional | hidden select:false | - | null | - | - | user.phone.desc | - |
notiInfo user.notiInfo | NotiInfo | Optional | hidden select:false | target: notiInfo | null | - | - | user.notiInfo.desc | - |
imageNum user.imageNum | Int | Optional | hidden select:false | - | 0 | - | - | user.imageNum.desc | - |
encourageInfo user.encourageInfo | EncourageInfo | Optional | hidden select:false | target: encourageInfo | [function] | - | - | user.encourageInfo.desc | - |
restrictInfo user.restrictInfo | RestrictInfo | Optional | hidden select:false | target: restrictInfo | null | - | - | user.restrictInfo.desc | - |
leaveInfo user.leaveInfo | LeaveInfo | Optional | hidden select:false | target: leaveInfo | null | - | - | user.leaveInfo.desc | - |
verifies user.verifies | [String] | Required | property | - | [] | - | verify: naver, kakao, github, google, apple, facebook, wallet, password, phone, email | user.verifies.desc | - |
roles user.roles | [String] | Required | property | - | ["user"] | - | userRole: root, admin, user, business, guest | user.roles.desc | - |
playing user.playing | [String] | Required | property | - | [] | - | - | user.playing.desc | - |
isOnline user.isOnline | Boolean | Required | property | - | true | - | - | user.isOnline.desc | - |
lastLoginAt user.lastLoginAt | Date | Required | property | - | [function] | - | - | user.lastLoginAt.desc | - |
joinAt user.joinAt | Date | Optional | property | - | null | - | - | user.joinAt.desc | - |
profileStatus user.profileStatus | String | Required | property | - | prepare | - | profileStatus: active, prepare, applied, approved, reapplied, featured, reserved, rejected | user.profileStatus.desc | - |
badgeCount user.badgeCount | Int | Required | property | - | 0 | - | - | user.badgeCount.desc | - |
status user.status | String | Required | property | - | prepare | - | userStatus: prepare, active, dormant, restricted | user.status.desc | - |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | Detail |
|---|---|---|---|---|---|---|---|---|---|
id user.id | ID | Required | property | - | null | - | - | user.id.desc | - |
createdAt user.createdAt | Date | Required | property | - | null | - | - | user.createdAt.desc | - |
updatedAt user.updatedAt | Date | Required | property | - | null | - | - | user.updatedAt.desc | - |
removedAt user.removedAt | Date | Optional | property | - | null | - | - | user.removedAt.desc | - |
nickname user.nickname | String | Optional | property | - | maxlength 12 | - | user.nickname.desc | - | |
image user.image | File | Optional | property | reference target: file | null | - | - | user.image.desc | - |
images user.images | [File] | Required | property | reference target: file | [] | - | - | user.images.desc | - |
appliedImages user.appliedImages | [File] | Required | property | reference target: file | [] | - | - | user.appliedImages.desc | - |
name user.name | String | Optional | hidden select:false | - | null | - | - | user.name.desc | - |
agreePolicies user.agreePolicies | [String] | Optional | hidden select:false | - | [] | - | - | user.agreePolicies.desc | - |
discord user.discord | Any | Optional | hidden select:false | - | {} | - | - | user.discord.desc | - |
accountId user.accountId | String | Optional | hidden select:false | - | null | - | - | user.accountId.desc | - |
password user.password | String | Optional | hidden select:false | - | null | - | - | user.password.desc | - |
phone user.phone | String | Optional | hidden select:false | - | null | - | - | user.phone.desc | - |
notiInfo user.notiInfo | NotiInfo | Optional | hidden select:false | target: notiInfo | null | - | - | user.notiInfo.desc | - |
imageNum user.imageNum | Int | Optional | hidden select:false | - | 0 | - | - | user.imageNum.desc | - |
encourageInfo user.encourageInfo | EncourageInfo | Optional | hidden select:false | target: encourageInfo | [function] | - | - | user.encourageInfo.desc | - |
restrictInfo user.restrictInfo | RestrictInfo | Optional | hidden select:false | target: restrictInfo | null | - | - | user.restrictInfo.desc | - |
leaveInfo user.leaveInfo | LeaveInfo | Optional | hidden select:false | target: leaveInfo | null | - | - | user.leaveInfo.desc | - |
verifies user.verifies | [String] | Required | property | - | [] | - | verify: naver, kakao, github, google, apple, facebook, wallet, password, phone, email | user.verifies.desc | - |
roles user.roles | [String] | Required | property | - | ["user"] | - | userRole: root, admin, user, business, guest | user.roles.desc | - |
playing user.playing | [String] | Required | property | - | [] | - | - | user.playing.desc | - |
isOnline user.isOnline | Boolean | Required | property | - | true | - | - | user.isOnline.desc | - |
lastLoginAt user.lastLoginAt | Date | Required | property | - | [function] | - | - | user.lastLoginAt.desc | - |
joinAt user.joinAt | Date | Optional | property | - | null | - | - | user.joinAt.desc | - |
profileStatus user.profileStatus | String | Required | property | - | prepare | - | profileStatus: active, prepare, applied, approved, reapplied, featured, reserved, rejected | user.profileStatus.desc | - |
badgeCount user.badgeCount | Int | Required | property | - | 0 | - | - | user.badgeCount.desc | - |
status user.status | String | Required | property | - | prepare | - | userStatus: prepare, active, dormant, restricted | user.status.desc | - |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | Detail |
|---|---|---|---|---|---|---|---|---|---|
id user.id | ID | Required | property | - | null | - | - | user.id.desc | - |
createdAt user.createdAt | Date | Required | property | - | null | - | - | user.createdAt.desc | - |
updatedAt user.updatedAt | Date | Required | property | - | null | - | - | user.updatedAt.desc | - |
removedAt user.removedAt | Date | Optional | property | - | null | - | - | user.removedAt.desc | - |
image user.image | File | Optional | property | reference target: file | null | - | - | user.image.desc | - |
nickname user.nickname | String | Optional | property | - | maxlength 12 | - | user.nickname.desc | - | |
playing user.playing | [String] | Required | property | - | [] | - | - | user.playing.desc | - |
profileStatus user.profileStatus | String | Required | property | - | prepare | - | profileStatus: active, prepare, applied, approved, reapplied, featured, reserved, rejected | user.profileStatus.desc | - |
lastLoginAt user.lastLoginAt | Date | Required | property | - | [function] | - | - | user.lastLoginAt.desc | - |
status user.status | String | Required | property | - | prepare | - | userStatus: prepare, active, dormant, restricted | user.status.desc | - |
| Key | Type | Required | Field Type | Relation | Default | Constraints | Enum | Description | Detail |
|---|---|---|---|---|---|---|---|---|---|
count user.count | Int | Required | property | - | 0 | accumulate | - | user.count.desc | - |
| Key | Ref Name | Type | Values | Descriptions | Used By |
|---|---|---|---|---|---|
| adminRole | adminRole | String | manager, admin, superAdmin | manager: adminRole.manager admin: adminRole.admin superAdmin: adminRole.superAdmin | - |
| bannerStatus | bannerStatus | String | active, displaying | active: bannerStatus.active displaying: bannerStatus.displaying | - |
| bannerTarget | bannerTarget | String | _blank, _self | _blank: bannerTarget._blank _self: bannerTarget._self | - |
| coordinateType | coordinateType | String | Point | Point: coordinateType.Point | - |
| fileStatus | fileStatus | String | active, uploading | active: fileStatus.active uploading: fileStatus.uploading | - |
| inquiry | inquiry | String | welcome, payable, waitPay, paid, morePayable, waitMorePay, inquired, concerned, concernedPayable, concernedWaitPay, ashed, vip, kicked | welcome: inquiry.welcome payable: inquiry.payable waitPay: inquiry.waitPay paid: inquiry.paid morePayable: inquiry.morePayable waitMorePay: inquiry.waitMorePay inquired: inquiry.inquired concerned: inquiry.concerned concernedPayable: inquiry.concernedPayable concernedWaitPay: inquiry.concernedWaitPay ashed: inquiry.ashed vip: inquiry.vip kicked: inquiry.kicked | - |
| journey | journey | String | welcome, waiting, firstJoin, joined, leaving, leaved, returning, returned | welcome: journey.welcome waiting: journey.waiting firstJoin: journey.firstJoin joined: journey.joined leaving: journey.leaving leaved: journey.leaved returning: journey.returning returned: journey.returned | - |
| leaveType | leaveType | String | noReply, comeback, unsatisfied, other | noReply: leaveType.noReply comeback: leaveType.comeback unsatisfied: leaveType.unsatisfied other: leaveType.other | - |
| linkType | linkType | String | website, twitter, discord, telegram, instagram, facebook, youtube, github, medium, linkedin, reddit, twitch, vimeo, weibo, wikipedia, app, email, other | website: linkType.website twitter: linkType.twitter discord: linkType.discord telegram: linkType.telegram instagram: linkType.instagram facebook: linkType.facebook youtube: linkType.youtube github: linkType.github medium: linkType.medium linkedin: linkType.linkedin reddit: linkType.reddit twitch: linkType.twitch vimeo: linkType.vimeo weibo: linkType.weibo wikipedia: linkType.wikipedia app: linkType.app email: linkType.email other: linkType.other | - |
| notificationType | notificationType | String | topic, token | topic: notificationType.topic token: notificationType.token | - |
| notiLevel | notiLevel | String | actionRequired, notice, essential, suggestion, advertise | actionRequired: notiLevel.actionRequired notice: notiLevel.notice essential: notiLevel.essential suggestion: notiLevel.suggestion advertise: notiLevel.advertise | - |
| notiSetting | notiSetting | String | disagree, fewer, normal, block | disagree: notiSetting.disagree fewer: notiSetting.fewer normal: notiSetting.normal block: notiSetting.block | - |
| periodType | periodType | String | non-periodic, active, hourly, daily, weekly, monthly | non-periodic: periodType.non-periodic active: periodType.active hourly: periodType.hourly daily: periodType.daily weekly: periodType.weekly monthly: periodType.monthly | - |
| profileStatus | profileStatus | String | active, prepare, applied, approved, reapplied, featured, reserved, rejected | active: profileStatus.active prepare: profileStatus.prepare applied: profileStatus.applied approved: profileStatus.approved reapplied: profileStatus.reapplied featured: profileStatus.featured reserved: profileStatus.reserved rejected: profileStatus.rejected | user.profileStatus (Object), user.profileStatus (Full), user.profileStatus (Light) |
| responsive | responsive | String | xl, lg, md, sm, xs | xl: responsive.xl lg: responsive.lg md: responsive.md sm: responsive.sm xs: responsive.xs | - |
| ssoType | ssoType | String | naver, kakao, github, google, apple, facebook | naver: ssoType.naver kakao: ssoType.kakao github: ssoType.github google: ssoType.google apple: ssoType.apple facebook: ssoType.facebook | - |
| summaryStatus | summaryStatus | String | active, archived | active: summaryStatus.active archived: summaryStatus.archived | - |
| userRole | userRole | String | root, admin, user, business, guest | root: userRole.root admin: userRole.admin user: userRole.user business: userRole.business guest: userRole.guest | user.roles (Object), user.roles (Full) |
| userStatus | userStatus | String | prepare, active, dormant, restricted | prepare: userStatus.prepare active: userStatus.active dormant: userStatus.dormant restricted: userStatus.restricted | user.status (Object), user.status (Full), user.status (Light) |
| verify | verify | String | naver, kakao, github, google, apple, facebook, wallet, password, phone, email | naver: verify.naver kakao: verify.kakao github: verify.github google: verify.google apple: verify.apple facebook: verify.facebook wallet: verify.wallet password: verify.password phone: verify.phone email: verify.email | user.verifies (Object), user.verifies (Full) |