Namirasoft Secret API V1

Namira Software Corporation Secret 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-secret-api-v1

Copied!

Commands


Health

Liveness

Returns the application liveness status

ns-secret health liveness

Copied!

Readiness

Returns the application readiness status

ns-secret health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-secret metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-secret value list {table} {column} {search} {field_id} {limit}

Copied!

Overview

Count

Returns the row count of every entity across all databases, optionally grouped by workspace_id and filtered to specific workspaces

ns-secret overview count

Copied!

--group_by_workspace (Boolean)

--workspace_ids (Array)

SecretCategory

List

Returns the secret category list

ns-secret secretcategory list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a secret category by id.

ns-secret secretcategory get {id}

Copied!

Create

Creates a new secret category for an entity

ns-secret secretcategory create

Copied!

--slot_id (String)

--category_id (String)

Delete

Deletes a secret category by an id.

ns-secret secretcategory delete {id}

Copied!

SecretField

List

Returns the secret field list

ns-secret secretfield list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a secret field by id.

ns-secret secretfield get {id}

Copied!

Create

Creates a new secret field for an entity

ns-secret secretfield create

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Update

Updates a secret field by an id for an entity

ns-secret secretfield update {id}

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a secret field by an id.

ns-secret secretfield delete {id}

Copied!

SecretTag

List

Returns the secret tag list

ns-secret secrettag list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a secret tag by id.

ns-secret secrettag get {id}

Copied!

Create

Creates a new secret tag for an entity

ns-secret secrettag create

Copied!

--name (String)

--value (String)

Update

Updates a secret tag by an id for an entity

ns-secret secrettag update {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a secret tag by an id.

ns-secret secrettag delete {id}

Copied!

Secret

List

Returns the secret list

ns-secret secret list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

IsValid

Determines if a hashed signature is valid or not

ns-secret secret isvalid

Copied!

--algorithm (Enum)

--passkey (Object)

--message (Object)

--signature (Object)

Get

Returns a secret by an id

ns-secret secret get {id}

Copied!

GetValue

Returns the value of a secret by an id

ns-secret secret getvalue {id}

Copied!

_GetValueFor

Returns the value of a secret by an id for an user_id

ns-secret secret _getvaluefor {user_id} {id}

Copied!

Create

Creates a new secret

ns-secret secret create

Copied!

--workspace_id (String)

--group (String)

--name (String)

--algorithm (Enum)

--value (String)

--secret_category (Array)

--secret_field (Array)

--secret_tag (Array)

_CreateFor

Creates a new secret for an user_id

ns-secret secret _createfor {user_id}

Copied!

--workspace_id (String)

--group (String)

--name (String)

--algorithm (Enum)

--value (String)

--secret_category (Array)

--secret_field (Array)

--secret_tag (Array)

UpdateValue

Updates the value of a secret by an id

ns-secret secret updatevalue {id}

Copied!

--value (String)

_UpdateValueFor

Updates the value of a secret by an id for an user_id

ns-secret secret _updatevaluefor {user_id} {id}

Copied!

--value (String)

Update

Updates a secret by an id

ns-secret secret update {id}

Copied!

--workspace_id (String)

--group (String)

--name (String)

--secret_category (Array)

--secret_field (Array)

--secret_tag (Array)

_UpdateFor

Updates a secret by an id for an user_id

ns-secret secret _updatefor {user_id} {id}

Copied!

--workspace_id (String)

--group (String)

--name (String)

--secret_category (Array)

--secret_field (Array)

--secret_tag (Array)

Delete

Deletes a secret by an id

ns-secret secret delete {id}

Copied!

_DeleteFor

Deletes a secret by an id for an user_id

ns-secret secret _deletefor {user_id} {id}

Copied!

Encrypt

Encrypts a message

ns-secret secret encrypt

Copied!

--algorithm (Enum)

--passkey (Object)

--message (Object)

Decrypt

Decrypts a message by a Secret

ns-secret secret decrypt

Copied!

--algorithm (Enum)

--passkey (Object)

--encrypted_message (Object)

EncryptTo

Encrypts a message and stores the result into a Secret

ns-secret secret encryptto

Copied!

--algorithm (Enum)

--passkey (Object)

--message (Object)

--target_secret_id (String)

--group (String)

--name (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
        }
    }
}

SecretCategory

{
    "name": "SecretCategory",
    "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
        }
    }
}

SecretField

{
    "name": "SecretField",
    "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
        }
    }
}

SecretTag

{
    "name": "SecretTag",
    "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
        }
    }
}

Secret

{
    "name": "Secret",
    "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
        },
        "group": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "name": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "algorithm": {
            "name": "SecretAlgorithm",
            "type": "Enum",
            "required": true,
            "valids": [
                "HASH_SHA256",
                "HASH_BCRYPT",
                "ENCRYPT_AES256CCM"
            ]
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

OptionalStringType

{
    "name": "OptionalStringType",
    "type": "Object",
    "required": true,
    "fields": {
        "constant": {
            "type": "String",
            "required": false
        },
        "secret_id": {
            "type": "String",
            "required": false
        }
    }
}

OptionalAnyType

{
    "name": "OptionalAnyType",
    "type": "Object",
    "required": true,
    "fields": {
        "constant": {
            "type": "Any",
            "required": false
        },
        "secret_id": {
            "type": "String",
            "required": false
        }
    }
}

SecretFull

{
    "name": "SecretFull",
    "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
        },
        "group": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "name": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "algorithm": {
            "name": "SecretAlgorithm",
            "type": "Enum",
            "required": true,
            "valids": [
                "HASH_SHA256",
                "HASH_BCRYPT",
                "ENCRYPT_AES256CCM"
            ]
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        },
        "secret_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
                        }
                    }
                }
            ]
        },
        "secret_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
                        }
                    }
                }
            ]
        },
        "secret_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
                        }
                    }
                }
            ]
        }
    }
}

SecretCreate

{
    "name": "SecretCreate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "group": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "name": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "algorithm": {
            "name": "SecretAlgorithm",
            "type": "Enum",
            "required": true,
            "valids": [
                "HASH_SHA256",
                "HASH_BCRYPT",
                "ENCRYPT_AES256CCM"
            ]
        },
        "value": {
            "type": "String",
            "required": true
        },
        "secret_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
                        }
                    }
                }
            ]
        },
        "secret_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
                        }
                    }
                }
            ]
        },
        "secret_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
                        }
                    }
                }
            ]
        }
    }
}

SecretUpdate

{
    "name": "SecretUpdate",
    "type": "Object",
    "required": true,
    "fields": {
        "workspace_id": {
            "type": "String",
            "required": false,
            "min": 20,
            "max": 20
        },
        "group": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "name": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "secret_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
                        }
                    }
                }
            ]
        },
        "secret_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
                        }
                    }
                }
            ]
        },
        "secret_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

SecretAlgorithm

HASH_SHA256

HASH_BCRYPT

ENCRYPT_AES256CCM

AlgorithmType

HASH_SHA256

HASH_BCRYPT

ENCRYPT_AES256CCM

Namira Software Corporation

©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.