Namirasoft Credential API V1
Namira Software Corporation Credential API Version 1 (1.4.5)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-credential-api-v1
Commands
Healthz
Get
Returns the application health status
ns-credential healthz get
Value
List
Returns the value list of a given table and column
ns-credential value list {table} {column} {search} {field_id} {limit}
AWSCategory
List
Returns the aws category list
ns-credential awscategory list {filters} {page} {size} {sorts}
Get
Returns a aws category by id.
ns-credential awscategory get {id}
Create
Creates a new aws category for an entity
ns-credential awscategory create {entity_id}
--category_id (String)
Delete
Deletes a aws category by an id.
ns-credential awscategory delete {entity_id} {id}
AWSField
List
Returns the aws field list
ns-credential awsfield list {filters} {page} {size} {sorts}
Get
Returns a aws field by id.
ns-credential awsfield get {id}
Create
Creates a new aws field for an entity
ns-credential awsfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a aws field by an id for an entity
ns-credential awsfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a aws field by an id.
ns-credential awsfield delete {entity_id} {id}
AWSTag
List
Returns the aws tag list
ns-credential awstag list {filters} {page} {size} {sorts}
Get
Returns a aws tag by id.
ns-credential awstag get {id}
Create
Creates a new aws tag for an entity
ns-credential awstag create {entity_id}
--name (String)
--value (String)
Update
Updates a aws tag by an id for an entity
ns-credential awstag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a aws tag by an id.
ns-credential awstag delete {entity_id} {id}
AWS
List
Returns the aws list
ns-credential aws list {filters} {page} {size} {sorts}
_GetFor
Returns an aws by an id for a user_id
ns-credential aws _getfor {user_id} {id}
Get
Returns an aws by an id
ns-credential aws get {id}
Create
Creates a new aws
ns-credential aws create
--workspace_id (String)
--name (String)
--access_key (String)
--secret_key (String)
--description (String)
--aws_category (Array)
--aws_field (Array)
--aws_tag (Array)
Update
Updates an aws by an id
ns-credential aws update {id}
--workspace_id (String)
--name (String)
--access_key (String)
--secret_key (String)
--description (String)
--aws_category (Array)
--aws_field (Array)
--aws_tag (Array)
Delete
Deletes an aws by an id
ns-credential aws delete {id}
AzureCategory
List
Returns the azure category list
ns-credential azurecategory list {filters} {page} {size} {sorts}
Get
Returns a azure category by id.
ns-credential azurecategory get {id}
Create
Creates a new azure category for an entity
ns-credential azurecategory create {entity_id}
--category_id (String)
Delete
Deletes a azure category by an id.
ns-credential azurecategory delete {entity_id} {id}
AzureField
List
Returns the azure field list
ns-credential azurefield list {filters} {page} {size} {sorts}
Get
Returns a azure field by id.
ns-credential azurefield get {id}
Create
Creates a new azure field for an entity
ns-credential azurefield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a azure field by an id for an entity
ns-credential azurefield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a azure field by an id.
ns-credential azurefield delete {entity_id} {id}
AzureTag
List
Returns the azure tag list
ns-credential azuretag list {filters} {page} {size} {sorts}
Get
Returns a azure tag by id.
ns-credential azuretag get {id}
Create
Creates a new azure tag for an entity
ns-credential azuretag create {entity_id}
--name (String)
--value (String)
Update
Updates a azure tag by an id for an entity
ns-credential azuretag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a azure tag by an id.
ns-credential azuretag delete {entity_id} {id}
Azure
List
Returns the azure list
ns-credential azure list {filters} {page} {size} {sorts}
_GetFor
Returns an azure by an id for a user_id
ns-credential azure _getfor {user_id} {id}
Get
Returns an azure by an id
ns-credential azure get {id}
Create
Creates a new azure
ns-credential azure create
--workspace_id (String)
--name (String)
--tenant_id (String)
--client_id (String)
--client_secret (String)
--description (String)
--azure_category (Array)
--azure_field (Array)
--azure_tag (Array)
Update
Updates an azure by an id
ns-credential azure update {id}
--workspace_id (String)
--name (String)
--tenant_id (String)
--client_id (String)
--client_secret (String)
--description (String)
--azure_category (Array)
--azure_field (Array)
--azure_tag (Array)
Delete
Deletes an azure by an id
ns-credential azure delete {id}
GCPCategory
List
Returns the gcp category list
ns-credential gcpcategory list {filters} {page} {size} {sorts}
Get
Returns a gcp category by id.
ns-credential gcpcategory get {id}
Create
Creates a new gcp category for an entity
ns-credential gcpcategory create {entity_id}
--category_id (String)
Delete
Deletes a gcp category by an id.
ns-credential gcpcategory delete {entity_id} {id}
GCPField
List
Returns the gcp field list
ns-credential gcpfield list {filters} {page} {size} {sorts}
Get
Returns a gcp field by id.
ns-credential gcpfield get {id}
Create
Creates a new gcp field for an entity
ns-credential gcpfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a gcp field by an id for an entity
ns-credential gcpfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a gcp field by an id.
ns-credential gcpfield delete {entity_id} {id}
GCPTag
List
Returns the gcp tag list
ns-credential gcptag list {filters} {page} {size} {sorts}
Get
Returns a gcp tag by id.
ns-credential gcptag get {id}
Create
Creates a new gcp tag for an entity
ns-credential gcptag create {entity_id}
--name (String)
--value (String)
Update
Updates a gcp tag by an id for an entity
ns-credential gcptag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a gcp tag by an id.
ns-credential gcptag delete {entity_id} {id}
GCP
List
Returns the gcp list
ns-credential gcp list {filters} {page} {size} {sorts}
_GetFor
Returns an gcp by an id for a user_id
ns-credential gcp _getfor {user_id} {id}
Get
Returns a gcp by an id
ns-credential gcp get {id}
Create
Creates a new gcp
ns-credential gcp create
--workspace_id (String)
--name (String)
--credentials (String)
--description (String)
--gcp_category (Array)
--gcp_field (Array)
--gcp_tag (Array)
Update
Updates a gcp by an id
ns-credential gcp update {id}
--workspace_id (String)
--name (String)
--credentials (String)
--description (String)
--gcp_category (Array)
--gcp_field (Array)
--gcp_tag (Array)
Delete
Deletes a gcp by an id
ns-credential gcp delete {id}
Schemas
AWSCategory
{ "name": "AWSCategory", "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 } }}
AWSField
{ "name": "AWSField", "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 } }}
AWSTag
{ "name": "AWSTag", "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 } }}
AWS
{ "name": "AWS", "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 }, "access_key": { "type": "String", "required": true, "min": 20, "max": 20 }, "secret_key": { "type": "String", "required": true, "min": 20, "max": 20 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AWSFull
{ "name": "AWSFull", "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 }, "access_key": { "type": "String", "required": true, "min": 20, "max": 20 }, "secret_key": { "type": "String", "required": true, "min": 20, "max": 20 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "aws_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "aws_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 } } } ] }, "aws_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 } } } ] } }}
AWSCreate
{ "name": "AWSCreate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "access_key": { "type": "String", "required": true }, "secret_key": { "type": "String", "required": true }, "description": { "type": "String", "required": false }, "aws_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "aws_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 } } } ] }, "aws_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 } } } ] } }}
AWSUpdate
{ "name": "AWSUpdate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "access_key": { "type": "String", "required": false }, "secret_key": { "type": "String", "required": false }, "description": { "type": "String", "required": false }, "aws_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "aws_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 } } } ] }, "aws_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 } } } ] } }}
AzureCategory
{ "name": "AzureCategory", "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 } }}
AzureField
{ "name": "AzureField", "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 } }}
AzureTag
{ "name": "AzureTag", "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 } }}
Azure
{ "name": "Azure", "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 }, "tenant_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "client_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "client_secret": { "type": "String", "required": true, "min": 20, "max": 20 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
AzureFull
{ "name": "AzureFull", "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 }, "tenant_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "client_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "client_secret": { "type": "String", "required": true, "min": 20, "max": 20 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "azure_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "azure_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 } } } ] }, "azure_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 } } } ] } }}
AzureCreate
{ "name": "AzureCreate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "tenant_id": { "type": "String", "required": true }, "client_id": { "type": "String", "required": true }, "client_secret": { "type": "String", "required": true }, "description": { "type": "String", "required": false }, "azure_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "azure_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 } } } ] }, "azure_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 } } } ] } }}
AzureUpdate
{ "name": "AzureUpdate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "tenant_id": { "type": "String", "required": false }, "client_id": { "type": "String", "required": false }, "client_secret": { "type": "String", "required": false }, "description": { "type": "String", "required": false }, "azure_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "azure_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 } } } ] }, "azure_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 } } } ] } }}
GCPCategory
{ "name": "GCPCategory", "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 } }}
GCPField
{ "name": "GCPField", "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 } }}
GCPTag
{ "name": "GCPTag", "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 } }}
GCP
{ "name": "GCP", "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 }, "credentials": { "type": "String", "required": true, "min": 20, "max": 20 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
GCPFull
{ "name": "GCPFull", "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 }, "credentials": { "type": "String", "required": true, "min": 20, "max": 20 }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "gcp_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "gcp_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 } } } ] }, "gcp_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 } } } ] } }}
GCPCreate
{ "name": "GCPCreate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "credentials": { "type": "String", "required": true }, "description": { "type": "String", "required": false }, "gcp_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "gcp_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 } } } ] }, "gcp_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 } } } ] } }}
GCPUpdate
{ "name": "GCPUpdate", "type": "Object", "required": true, "fields": { "workspace_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "credentials": { "type": "String", "required": false }, "description": { "type": "String", "required": false }, "gcp_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "gcp_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 } } } ] }, "gcp_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.