Namirasoft Password API V1
Namira Software Corporation Password API Version 1 (1.4.23)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-password-api-v1
Commands
Healthz
Get
Returns the application health status
ns-password healthz get
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}
Entry
List
Returns the entry list
ns-password entry list {filters} {page} {size} {sorts}
Get
Returns an entry by an id
ns-password entry get {id}
Create
Creates a new entry
ns-password entry create
--group_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}
--group_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}
Group
List
Returns the group list
ns-password group list {filters} {page} {size} {sorts}
Get
Returns a group by an id
ns-password group get {id}
Create
Creates a new group
ns-password group create
--name (String)
--description (String)
Update
Updates a group by an id
ns-password group update {id}
--name (String)
--description (String)
Delete
Deletes a group by an id
ns-password group delete {id}
Question
List
Returns the question list
ns-password question list
Template
List
Returns the template list
ns-password template list {filters} {page} {size} {sorts}
Get
Returns a template by an id
ns-password template get {id}
Create
Creates a new template
ns-password template create
--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)
Update
Updates a template by an id
ns-password template update {id}
--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)
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
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 }, "group_id": { "type": "String", "required": false, "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, "max": 255 }, "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": { "group_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, "max": 255 }, "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": { "entity_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": { "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 } } } ] }, "entry_tag": { "type": "Array", "required": true, "items": [ { "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "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 } }}
EntityCategoryInput
{ "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } }}
EntityFieldInput
{ "name": "EntityFieldInput", "type": "Object", "required": false, "fields": { "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 } }}
EntityTagInput
{ "name": "EntityTagInput", "type": "Object", "required": false, "fields": { "entity_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "value": { "type": "String", "required": false } }}
Group
{ "name": "Group", "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": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GroupFull
{ "name": "GroupFull", "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": true, "max": 255 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GroupInput
{ "name": "GroupInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false } }}
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 }, "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": { "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 } }}
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 } ] } }}
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 2025 Namira Software Corporation. All rights reserved.