Namirasoft Secret API V1

Namira Software Corporation Secret API Version 1 (1.4.21)

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


Healthz

Get

Returns the application health status

ns-secret healthz get

Copied!

Value

List

Returns the value list of a given table and column

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

Copied!

SecretCategory

List

Returns the secret category list

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

Copied!

Get

Returns a secret category by id.

ns-secret secretcategory get {id}

Copied!

Create

Creates a new secret category

ns-secret secretcategory create

Copied!

--entity_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} {user_id}

Copied!

Get

Returns a secret field by id.

ns-secret secretfield get {id}

Copied!

Create

Creates a new secret field

ns-secret secretfield create

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

Update

Updates a secret field by an id

ns-secret secretfield update {id}

Copied!

--entity_id (String)

--field_id (String)

--value (String)

--description (String)

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} {user_id}

Copied!

Get

Returns a secret tag by id.

ns-secret secrettag get {id}

Copied!

Create

Creates a new secret tag

ns-secret secrettag create

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (String)

Update

Updates a secret tag by an id

ns-secret secrettag update {id}

Copied!

--entity_id (String)

--name (String)

--value (String)

--description (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} {user_id}

Copied!

Get

Returns a secret by an id

ns-secret secret get {id}

Copied!

GetValue

Returns a value secret by an id

ns-secret secret getvalue {id}

Copied!

Create

Creates a new secret

ns-secret secret create

Copied!

--group (String)

--name (String)

--algorithm (Enum)

--value (String)

UpdateValue

Updates a value secret by an id

ns-secret secret updatevalue {id}

Copied!

--value (String)

Update

Updates a secret by an id

ns-secret secret update {id}

Copied!

--group (String)

--name (String)

Delete

Deletes a secret by an id

ns-secret secret delete {id}

Copied!

IsValid

Determines if a hashed signature is valid or not

ns-secret secret isvalid

Copied!

--algorithm (Enum)

--passkey (Object)

--message (Object)

--signature (Object)

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


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
    },
    "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": {
    "entity_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
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "String",
      "required": true
    },
    "description": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityFieldInput

{
  "name": "EntityFieldInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "field_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "value": {
      "type": "String",
      "required": true
    },
    "description": {
      "type": "String",
      "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": true
    },
    "description": {
      "type": "String",
      "required": false
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

EntityTagInput

{
  "name": "EntityTagInput",
  "type": "Object",
  "required": true,
  "fields": {
    "entity_id": {
      "type": "String",
      "required": true,
      "min": 20,
      "max": 20
    },
    "name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "value": {
      "type": "String",
      "required": true
    },
    "description": {
      "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
    },
    "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_BYCRYPT",
        "ENCRYPT_AES256CCM"
      ]
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    }
  }
}

SecretCreate

{
  "name": "SecretCreate",
  "type": "Object",
  "required": true,
  "fields": {
    "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_BYCRYPT",
        "ENCRYPT_AES256CCM"
      ]
    },
    "value": {
      "type": "String",
      "required": true
    }
  }
}

SecretUpdate

{
  "name": "SecretUpdate",
  "type": "Object",
  "required": true,
  "fields": {
    "group": {
      "type": "String",
      "required": false,
      "max": 255
    },
    "name": {
      "type": "String",
      "required": false,
      "max": 255
    }
  }
}

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

Enums

SecretAlgorithm

HASH_SHA256

HASH_BYCRYPT

ENCRYPT_AES256CCM

AlgorithmType

HASH_SHA256

HASH_BYCRYPT

ENCRYPT_AES256CCM

Namira Software Corporation

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