Namirasoft Account API V1
Namira Software Corporation Account API Version 1 (1.4.56)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-account-api-v1
Commands
Healthz
Get
Returns the application health status
ns-account healthz get
Value
List
Returns the value list of a given table and column
ns-account value list {table} {column} {search} {field_id} {limit}
Country
List
Returns the country list
ns-account country list
Request
Email request
ns-account email request
Verify
Verify email
ns-account email verify
--code (String)
Password
Forget
Forget password
ns-account password forget
--email (Email)
New
New password
ns-account password new
--user_id (String)
--hash (String)
--pass_new (String)
--pass_rep (String)
Reset
Reset password
ns-account password reset
--pass_cur (String)
--pass_new (String)
--pass_rep (String)
Phone
Request
Sends a phone validation request by SMS
ns-account phone request
Verify
Verify phone
ns-account phone verify
--code (String)
SessionCategory
List
Returns the session category list
ns-account sessioncategory list {filters} {page} {size} {sorts}
Get
Returns a session category by id.
ns-account sessioncategory get {id}
Create
Creates a new session category for an entity
ns-account sessioncategory create {entity_id}
--category_id (String)
Delete
Deletes a session category by an id.
ns-account sessioncategory delete {entity_id} {id}
SessionField
List
Returns the session field list
ns-account sessionfield list {filters} {page} {size} {sorts}
Get
Returns a session field by id.
ns-account sessionfield get {id}
Create
Creates a new session field for an entity
ns-account sessionfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a session field by an id for an entity
ns-account sessionfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a session field by an id.
ns-account sessionfield delete {entity_id} {id}
SessionTag
List
Returns the session tag list
ns-account sessiontag list {filters} {page} {size} {sorts}
Get
Returns a session tag by id.
ns-account sessiontag get {id}
Create
Creates a new session tag for an entity
ns-account sessiontag create {entity_id}
--name (String)
--value (String)
Update
Updates a session tag by an id for an entity
ns-account sessiontag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a session tag by an id.
ns-account sessiontag delete {entity_id} {id}
Session
Login
Logins and Returns a new session
ns-account session login
--email (Email)
--password (String)
--os (String)
Logout
Logout from the current session
ns-account session logout
Current
Signs the current session.
ns-account session current
List
Returns the session list
ns-account session list {filters} {page} {size} {sorts}
GetToken
Returns a session token by an id
ns-account session gettoken {id}
Get
Returns a session by an id
ns-account session get {id}
_Sign
Signs a session by an id
ns-account session _sign {id}
Delete
Deletes a session by an id
ns-account session delete {id}
UserCategory
List
Returns the user category list
ns-account usercategory list {filters} {page} {size} {sorts}
Get
Returns a user category by id.
ns-account usercategory get {id}
Create
Creates a new user category for an entity
ns-account usercategory create {entity_id}
--category_id (String)
Delete
Deletes a user category by an id.
ns-account usercategory delete {entity_id} {id}
UserField
List
Returns the user field list
ns-account userfield list {filters} {page} {size} {sorts}
Get
Returns a user field by id.
ns-account userfield get {id}
Create
Creates a new user field for an entity
ns-account userfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a user field by an id for an entity
ns-account userfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a user field by an id.
ns-account userfield delete {entity_id} {id}
UserTag
List
Returns the user tag list
ns-account usertag list {filters} {page} {size} {sorts}
Get
Returns a user tag by id.
ns-account usertag get {id}
Create
Creates a new user tag for an entity
ns-account usertag create {entity_id}
--name (String)
--value (String)
Update
Updates a user tag by an id for an entity
ns-account usertag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a user tag by an id.
ns-account usertag delete {entity_id} {id}
User
Current
Returns the user
ns-account user current
Register
registers a user
ns-account user register
--first_name (String)
--last_name (String)
--country (String)
--email (Email)
--phone (String)
--birthday (String)
--password (String)
--os (String)
User google
ns-account user google
--client_id (String)
--credential (String)
--os (String)
Banned
Banned an user by an id
ns-account user banned {id}
Cancel
Cancels the user deletion
ns-account user cancel
Update
Updates the current user
ns-account user update
--first_name (String)
--last_name (String)
--email (Email)
--phone (String)
--birthday (String)
Delete
Marks the current user for deletion
ns-account user delete
_GetByEmail
Returns an user by an email
ns-account user _getbyemail {email}
GetShort
Returns the short of an user by an id
ns-account user getshort {id}
_Get
Returns an user by an id
ns-account user _get {id}
ServiceUser
List
Returns the service user list
ns-account serviceuser list {filters} {page} {size} {sorts}
Get
Returns a service user by an id
ns-account serviceuser get {id}
Create
Creates a new service user
ns-account serviceuser create
--name (String)
--user_category (Array)
--user_field (Array)
--user_tag (Array)
Update
Updates a service user by an id
ns-account serviceuser update {id}
--name (String)
--user_category (Array)
--user_field (Array)
--user_tag (Array)
Delete
Deletes a service user by an id
ns-account serviceuser delete {id}
ServiceSession
List
Returns the service session list
ns-account servicesession list {filters} {page} {size} {sorts}
GetToken
Returns a service session token by an id
ns-account servicesession gettoken {id}
Get
Returns a service session by an id
ns-account servicesession get {id}
Create
Creates a new service session
ns-account servicesession create
--user_id (String)
--name (String)
--os (String)
--session_category (Array)
--session_field (Array)
--session_tag (Array)
Delete
Deletes a service session by an id
ns-account servicesession delete {id}
NotificationSetting
List
Returns the notification setting list
ns-account notificationsetting list
Set
Updates notification settings
ns-account notificationsetting set
Schemas
Country
{ "name": "Country", "type": "Object", "required": true}
SessionCategory
{ "name": "SessionCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": true, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
SessionField
{ "name": "SessionField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
SessionTag
{ "name": "SessionTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
SessionLogin
{ "name": "SessionLogin", "type": "Object", "required": true, "fields": { "email": { "regex": {}, "type": "Email", "required": true }, "password": { "type": "String", "required": true }, "os": { "type": "String", "required": true } }}
NamirasoftAccountToken
{ "name": "NamirasoftAccountToken", "type": "Object", "required": true}
Session
{ "name": "Session", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "os": { "type": "String", "required": false, "max": 255 }, "ip": { "type": "String", "required": false, "max": 255 }, "continent": { "type": "String", "required": false, "max": 255 }, "country": { "type": "String", "required": false, "max": 255 }, "city": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
SessionFull
{ "name": "SessionFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "os": { "type": "String", "required": false, "max": 255 }, "ip": { "type": "String", "required": false, "max": 255 }, "continent": { "type": "String", "required": false, "max": 255 }, "country": { "type": "String", "required": false, "max": 255 }, "city": { "type": "String", "required": false, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "session_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "session_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "session_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
UserCategory
{ "name": "UserCategory", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
UserField
{ "name": "UserField", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
UserTag
{ "name": "UserTag", "type": "Object", "required": true, "fields": { "id": { "type": "Integer", "required": true }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
User
{ "name": "User", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "first_name": { "type": "String", "required": true, "max": 255 }, "last_name": { "type": "String", "required": true, "max": 255 }, "country_code": { "type": "String", "required": true, "max": 255 }, "country": { "type": "String", "required": true, "max": 255 }, "email": { "type": "String", "required": true, "max": 255 }, "phone": { "type": "String", "required": false, "max": 15 }, "birthday": { "type": "Date", "required": false }, "tester": { "type": "Boolean", "required": true }, "approved": { "type": "Boolean", "required": true }, "approved_reason": { "type": "String", "required": false }, "banned": { "type": "Boolean", "required": true }, "banned_reason": { "type": "String", "required": false }, "premium": { "type": "Boolean", "required": true }, "premium_reason": { "type": "String", "required": false }, "notification_setting": { "type": "Any", "required": false }, "e_verified": { "type": "Boolean", "required": true }, "p_verified": { "type": "Boolean", "required": true }, "will_be_deleted_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
UserCreate
{ "name": "UserCreate", "type": "Object", "required": true, "fields": { "first_name": { "type": "String", "required": true }, "last_name": { "type": "String", "required": true }, "country": { "type": "String", "required": true }, "email": { "regex": {}, "type": "Email", "required": true }, "phone": { "type": "String", "required": false }, "birthday": { "type": "String", "required": false }, "password": { "type": "String", "required": true }, "os": { "type": "String", "required": true } }}
UserCreateByGoogle
{ "name": "UserCreateByGoogle", "type": "Object", "required": true, "fields": { "client_id": { "type": "String", "required": true }, "credential": { "type": "String", "required": true }, "os": { "type": "String", "required": true } }}
UserUpdate
{ "name": "UserUpdate", "type": "Object", "required": true, "fields": { "first_name": { "type": "String", "required": false }, "last_name": { "type": "String", "required": false }, "email": { "regex": {}, "type": "Email", "required": false }, "phone": { "type": "String", "required": false }, "birthday": { "type": "String", "required": false } }}
UserFull
{ "name": "UserFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "first_name": { "type": "String", "required": true, "max": 255 }, "last_name": { "type": "String", "required": true, "max": 255 }, "country_code": { "type": "String", "required": true, "max": 255 }, "country": { "type": "String", "required": true, "max": 255 }, "email": { "type": "String", "required": true, "max": 255 }, "phone": { "type": "String", "required": false, "max": 15 }, "birthday": { "type": "Date", "required": false }, "tester": { "type": "Boolean", "required": true }, "approved": { "type": "Boolean", "required": true }, "approved_reason": { "type": "String", "required": false }, "banned": { "type": "Boolean", "required": true }, "banned_reason": { "type": "String", "required": false }, "premium": { "type": "Boolean", "required": true }, "premium_reason": { "type": "String", "required": false }, "notification_setting": { "type": "Any", "required": false }, "e_verified": { "type": "Boolean", "required": true }, "p_verified": { "type": "Boolean", "required": true }, "will_be_deleted_at": { "type": "DateTime", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "user_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "user_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "user_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
UserShort
{ "name": "UserShort", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true }, "user_id": { "type": "String", "required": false }, "first_name": { "type": "String", "required": true }, "last_name": { "type": "String", "required": true } }}
ServiceUserInput
{ "name": "ServiceUserInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true }, "user_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "user_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "user_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
ServiceSessionCreate
{ "name": "ServiceSessionCreate", "type": "Object", "required": true, "fields": { "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": false, "max": 255 }, "os": { "type": "String", "required": false, "max": 255 }, "session_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "session_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "session_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } } } ] } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.