Namirasoft Password API V1
Namira Software Corporation Password API Version 1 (1.5.4)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-password-api-v1
Commands
Health
Liveness
Returns the application liveness status
ns-password health liveness
Readiness
Returns the application readiness status
ns-password health readiness
Metrics
Get
Returns the application metrics
ns-password metrics get
Value
List
Returns the value list of a given table and column
ns-password value list {table} {column} {search} {field_id} {limit}
Overview
Count
Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces
ns-password overview count
--group_by_workspace (Boolean)
--workspace_ids (Array)
EntryCategory
List
Returns the entry category list
ns-password entrycategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a entry category by id.
ns-password entrycategory get {id}
Create
Creates a new entry category for an entity
ns-password entrycategory create
--slot_id (String)
--category_id (String)
Delete
Deletes a entry category by an id.
ns-password entrycategory delete {id}
EntryField
List
Returns the entry field list
ns-password entryfield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a entry field by id.
ns-password entryfield get {id}
Create
Creates a new entry field for an entity
ns-password entryfield create
--slot_id (String)
--field_id (String)
--value (Any)
Update
Updates a entry field by an id for an entity
ns-password entryfield update {id}
--slot_id (String)
--field_id (String)
--value (Any)
Delete
Deletes a entry field by an id.
ns-password entryfield delete {id}
EntryTag
List
Returns the entry tag list
ns-password entrytag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a entry tag by id.
ns-password entrytag get {id}
Create
Creates a new entry tag for an entity
ns-password entrytag create
--name (String)
--value (String)
Update
Updates a entry tag by an id for an entity
ns-password entrytag update {id}
--name (String)
--value (String)
Delete
Deletes a entry tag by an id.
ns-password entrytag delete {id}
Entry
List
Returns the entry list
ns-password entry list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns an entry by an id
ns-password entry get {id}
Create
Creates a new entry
ns-password entry create
--workspace_id (String)
--name (String)
--hash (String)
--url (String)
--description (String)
--entry_line (Array)
--entry_category (Array)
--entry_field (Array)
--entry_tag (Array)
Update
Updates an entry by an id
ns-password entry update {id}
--workspace_id (String)
--name (String)
--hash (String)
--url (String)
--description (String)
--entry_line (Array)
--entry_category (Array)
--entry_field (Array)
--entry_tag (Array)
Delete
Deletes an entry by an id
ns-password entry delete {id}
Question
List
Returns the question list
ns-password question list
TemplateCategory
List
Returns the template category list
ns-password templatecategory list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a template category by id.
ns-password templatecategory get {id}
Create
Creates a new template category for an entity
ns-password templatecategory create
--slot_id (String)
--category_id (String)
Delete
Deletes a template category by an id.
ns-password templatecategory delete {id}
TemplateField
List
Returns the template field list
ns-password templatefield list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a template field by id.
ns-password templatefield get {id}
Create
Creates a new template field for an entity
ns-password templatefield create
--slot_id (String)
--field_id (String)
--value (Any)
Update
Updates a template field by an id for an entity
ns-password templatefield update {id}
--slot_id (String)
--field_id (String)
--value (Any)
Delete
Deletes a template field by an id.
ns-password templatefield delete {id}
TemplateTag
List
Returns the template tag list
ns-password templatetag list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a template tag by id.
ns-password templatetag get {id}
Create
Creates a new template tag for an entity
ns-password templatetag create
--name (String)
--value (String)
Update
Updates a template tag by an id for an entity
ns-password templatetag update {id}
--name (String)
--value (String)
Delete
Deletes a template tag by an id.
ns-password templatetag delete {id}
Template
List
Returns the template list
ns-password template list {filters} {page} {size} {sorts} {all_workspaces}
Get
Returns a template by an id
ns-password template get {id}
Create
Creates a new template
ns-password template create
--workspace_id (String)
--name (String)
--length (Integer)
--type (Enum)
--character_set_uppercase (Boolean)
--character_set_lowercase (Boolean)
--character_set_digit (Boolean)
--character_set_minus (Boolean)
--character_set_underline (Boolean)
--character_set_space (Boolean)
--character_set_special (Boolean)
--character_set_brackets (Boolean)
--character_set_latin_1_supplement (Boolean)
--pattern (String)
--pattern_randomly_permute (Boolean)
--description (String)
--template_category (Array)
--template_field (Array)
--template_tag (Array)
Update
Updates a template by an id
ns-password template update {id}
--workspace_id (String)
--name (String)
--length (Integer)
--type (Enum)
--character_set_uppercase (Boolean)
--character_set_lowercase (Boolean)
--character_set_digit (Boolean)
--character_set_minus (Boolean)
--character_set_underline (Boolean)
--character_set_space (Boolean)
--character_set_special (Boolean)
--character_set_brackets (Boolean)
--character_set_latin_1_supplement (Boolean)
--pattern (String)
--pattern_randomly_permute (Boolean)
--description (String)
--template_category (Array)
--template_field (Array)
--template_tag (Array)
Delete
Deletes a template by an id
ns-password template delete {id}
User
Setup
Setups a new user
ns-password user setup
--cipher (String)
--questions (Array)
--ciphers (Array)
Get
Returns an user
ns-password user get
Set
Sets a new cipher for user
ns-password user set
--cipher (String)
Schemas
OverviewCountInput
{ "name": "OverviewCountInput", "type": "Object", "required": true, "fields": { "group_by_workspace": { "type": "Boolean", "required": false }, "workspace_ids": { "type": "Array", "required": false, "items": [ { "type": "String", "required": true } ] } }}
OverviewCountRow
{ "name": "OverviewCountRow", "type": "Object", "required": true, "fields": { "database": { "type": "String", "required": true }, "table": { "type": "String", "required": true }, "total": { "type": "Integer", "required": true }, "by_workspace": { "type": "Array", "required": false, "items": [ { "name": "OverviewCountByWorkspace", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } } } ] } }}
OverviewCountByWorkspace
{ "name": "OverviewCountByWorkspace", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": true }, "count": { "type": "Integer", "required": true } }}
EntryCategory
{ "name": "EntryCategory", "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 }, "slot_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": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
EntryField
{ "name": "EntryField", "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 }, "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": true, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } }}
EntryTag
{ "name": "EntryTag", "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 } }}
Entry
{ "name": "Entry", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "hash": { "type": "String", "required": true, "max": 255 }, "domain": { "type": "String", "required": true, "max": 255 }, "host": { "type": "String", "required": true, "max": 255 }, "url": { "type": "String", "required": false }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "entry_line": { "type": "Array", "required": true, "items": [ { "name": "EntryLine", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entry_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "order": { "type": "Integer", "required": true }, "sensitive": { "type": "Boolean", "required": true }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] } }}
EntryLine
{ "name": "EntryLine", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "entry_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "order": { "type": "Integer", "required": true }, "sensitive": { "type": "Boolean", "required": true }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
EntryInput
{ "name": "EntryInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "hash": { "type": "String", "required": true, "max": 255 }, "url": { "type": "String", "required": false }, "description": { "type": "String", "required": false }, "entry_line": { "type": "Array", "required": true, "items": [ { "name": "EntryLineInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "sensitive": { "type": "Boolean", "required": true }, "value": { "type": "String", "required": false } } } ] }, "entry_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "entry_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "entry_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 } } } ] } }}
EntryLineInput
{ "name": "EntryLineInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "sensitive": { "type": "Boolean", "required": true }, "value": { "type": "String", "required": false } }}
TemplateCategory
{ "name": "TemplateCategory", "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 }, "slot_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 } }}
TemplateField
{ "name": "TemplateField", "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 }, "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
TemplateTag
{ "name": "TemplateTag", "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 } }}
Template
{ "name": "Template", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "workspace_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "length": { "type": "Integer", "required": true }, "type": { "name": "TemplateType", "type": "Enum", "required": true, "valids": [ "CharacterSet", "Pattern" ] }, "character_set_uppercase": { "type": "Boolean", "required": true }, "character_set_lowercase": { "type": "Boolean", "required": true }, "character_set_digit": { "type": "Boolean", "required": true }, "character_set_minus": { "type": "Boolean", "required": true }, "character_set_underline": { "type": "Boolean", "required": true }, "character_set_space": { "type": "Boolean", "required": true }, "character_set_special": { "type": "Boolean", "required": true }, "character_set_brackets": { "type": "Boolean", "required": true }, "character_set_latin_1_supplement": { "type": "Boolean", "required": true }, "pattern": { "type": "String", "required": false, "max": 255 }, "pattern_randomly_permute": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
TemplateInput
{ "name": "TemplateInput", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "length": { "type": "Integer", "required": true }, "type": { "name": "TemplateType", "type": "Enum", "required": true, "valids": [ "CharacterSet", "Pattern" ] }, "character_set_uppercase": { "type": "Boolean", "required": true }, "character_set_lowercase": { "type": "Boolean", "required": true }, "character_set_digit": { "type": "Boolean", "required": true }, "character_set_minus": { "type": "Boolean", "required": true }, "character_set_underline": { "type": "Boolean", "required": true }, "character_set_space": { "type": "Boolean", "required": true }, "character_set_special": { "type": "Boolean", "required": true }, "character_set_brackets": { "type": "Boolean", "required": true }, "character_set_latin_1_supplement": { "type": "Boolean", "required": true }, "pattern": { "type": "String", "required": false, "max": 255 }, "pattern_randomly_permute": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "template_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "template_field": { "type": "Array", "required": true, "items": [ { "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "slot_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "field_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "value": { "type": "Any", "required": false } } } ] }, "template_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 } } } ] } }}
UserInput
{ "name": "UserInput", "type": "Object", "required": true, "fields": { "cipher": { "type": "String", "required": true }, "questions": { "type": "Array", "required": true, "items": [ { "type": "String", "required": true } ] }, "ciphers": { "type": "Array", "required": true, "items": [ { "type": "String", "required": true } ] } }}
UserSetupResponse
{ "name": "UserSetupResponse", "type": "Object", "required": true, "fields": { "user": { "name": "UserFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "cipher_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "cipher": { "type": "String", "required": true } } }, "cipher": { "type": "String", "required": true } }}
UserFull
{ "name": "UserFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "cipher_secret_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "cipher": { "type": "String", "required": true } }}
Enums
TemplateType
CharacterSet
Pattern
Namira Software Corporation
©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.