Namirasoft Access API V1
Namira Software Corporation Access API Version 1 (1.4.63)
Install
To use this cli, we need to first Install Nodejs, then run the following command.
npm i -g namirasoft-access-api-v1
Commands
Healthz
Get
Returns the application health status
ns-access healthz get
Value
List
Returns the value list of a given table and column
ns-access value list {table} {column} {search} {field_id} {limit}
PermissionCategory
List
Returns the permission category list
ns-access permissioncategory list {filters} {page} {size} {sorts}
Get
Returns a permission category by id.
ns-access permissioncategory get {id}
Create
Creates a new permission category for an entity
ns-access permissioncategory create {entity_id}
--category_id (String)
Delete
Deletes a permission category by an id.
ns-access permissioncategory delete {entity_id} {id}
PermissionField
List
Returns the permission field list
ns-access permissionfield list {filters} {page} {size} {sorts}
Get
Returns a permission field by id.
ns-access permissionfield get {id}
Create
Creates a new permission field for an entity
ns-access permissionfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a permission field by an id for an entity
ns-access permissionfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a permission field by an id.
ns-access permissionfield delete {entity_id} {id}
PermissionTag
List
Returns the permission tag list
ns-access permissiontag list {filters} {page} {size} {sorts}
Get
Returns a permission tag by id.
ns-access permissiontag get {id}
Create
Creates a new permission tag for an entity
ns-access permissiontag create {entity_id}
--name (String)
--value (String)
Update
Updates a permission tag by an id for an entity
ns-access permissiontag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a permission tag by an id.
ns-access permissiontag delete {entity_id} {id}
Permission
List
Returns the permission list
ns-access permission list {filters} {page} {size} {sorts}
ListOutgoing
Returns the outgoing permission list
ns-access permission listoutgoing {filters} {page} {size} {sorts}
ListIncoming
Returns the incoming permission list
ns-access permission listincoming {filters} {page} {size} {sorts}
Get
Returns a permission by an id
ns-access permission get {id}
GetIncoming
Returns an incoming permission by an id
ns-access permission getincoming {id}
GetOutgoing
Returns an outgoing permission by an id
ns-access permission getoutgoing {id}
Create
Creates a new permission
ns-access permission create
--to_email (String)
--policies (Array)
--roles (Array)
--permission_category (Array)
--permission_field (Array)
--permission_tag (Array)
Update
Updates a permission by an id
ns-access permission update {id}
--to_email (String)
--policies (Array)
--roles (Array)
--permission_category (Array)
--permission_field (Array)
--permission_tag (Array)
DeleteOutgoing
Deletes an outgoing permission by an id
ns-access permission deleteoutgoing {id}
DeleteIncoming
Deletes an incoming permission by an id
ns-access permission deleteincoming {id}
PolicyCategory
List
Returns the policy category list
ns-access policycategory list {filters} {page} {size} {sorts}
Get
Returns a policy category by id.
ns-access policycategory get {id}
Create
Creates a new policy category for an entity
ns-access policycategory create {entity_id}
--category_id (String)
Delete
Deletes a policy category by an id.
ns-access policycategory delete {entity_id} {id}
PolicyField
List
Returns the policy field list
ns-access policyfield list {filters} {page} {size} {sorts}
Get
Returns a policy field by id.
ns-access policyfield get {id}
Create
Creates a new policy field for an entity
ns-access policyfield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a policy field by an id for an entity
ns-access policyfield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a policy field by an id.
ns-access policyfield delete {entity_id} {id}
PolicyTag
List
Returns the policy tag list
ns-access policytag list {filters} {page} {size} {sorts}
Get
Returns a policy tag by id.
ns-access policytag get {id}
Create
Creates a new policy tag for an entity
ns-access policytag create {entity_id}
--name (String)
--value (String)
Update
Updates a policy tag by an id for an entity
ns-access policytag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a policy tag by an id.
ns-access policytag delete {entity_id} {id}
Policy
List
Returns the policy list
ns-access policy list {filters} {page} {size} {sorts}
ListIncoming
Returns the incoming policy list
ns-access policy listincoming {filters} {page} {size} {sorts}
Get
Returns a policy by an id
ns-access policy get {id}
GetIncoming
Returns an incoming policy by an id
ns-access policy getincoming {id}
Create
Creates a new policy
ns-access policy create
--product_id (String)
--name (String)
--entity (String)
--actions (String)
--resources (String)
--allow (Boolean)
--description (String)
--policy_category (Array)
--policy_field (Array)
--policy_tag (Array)
Update
Updates a policy by an id
ns-access policy update {id}
--product_id (String)
--name (String)
--entity (String)
--actions (String)
--resources (String)
--allow (Boolean)
--description (String)
--policy_category (Array)
--policy_field (Array)
--policy_tag (Array)
Delete
Deletes a policy by an id
ns-access policy delete {id}
RoleCategory
List
Returns the role category list
ns-access rolecategory list {filters} {page} {size} {sorts}
Get
Returns a role category by id.
ns-access rolecategory get {id}
Create
Creates a new role category for an entity
ns-access rolecategory create {entity_id}
--category_id (String)
Delete
Deletes a role category by an id.
ns-access rolecategory delete {entity_id} {id}
RoleField
List
Returns the role field list
ns-access rolefield list {filters} {page} {size} {sorts}
Get
Returns a role field by id.
ns-access rolefield get {id}
Create
Creates a new role field for an entity
ns-access rolefield create {entity_id}
--field_id (String)
--value (Any)
Update
Updates a role field by an id for an entity
ns-access rolefield update {entity_id} {id}
--field_id (String)
--value (Any)
Delete
Deletes a role field by an id.
ns-access rolefield delete {entity_id} {id}
RoleTag
List
Returns the role tag list
ns-access roletag list {filters} {page} {size} {sorts}
Get
Returns a role tag by id.
ns-access roletag get {id}
Create
Creates a new role tag for an entity
ns-access roletag create {entity_id}
--name (String)
--value (String)
Update
Updates a role tag by an id for an entity
ns-access roletag update {entity_id} {id}
--name (String)
--value (String)
Delete
Deletes a role tag by an id.
ns-access roletag delete {entity_id} {id}
Role
List
Returns the role list
ns-access role list {filters} {page} {size} {sorts}
ListIncoming
Returns the incoming role list
ns-access role listincoming {filters} {page} {size} {sorts}
Get
Returns a role by an id
ns-access role get {id}
GetIncoming
Returns an incoming role by an id
ns-access role getincoming {id}
Create
Creates a new role
ns-access role create
--name (String)
--description (String)
--policies (Array)
--role_category (Array)
--role_field (Array)
--role_tag (Array)
Update
Updates a role by an id
ns-access role update {id}
--name (String)
--description (String)
--policies (Array)
--role_category (Array)
--role_field (Array)
--role_tag (Array)
Delete
Deletes a role by an id
ns-access role delete {id}
Access
_GetFor
Returns an access for a user_id
ns-access access _getfor {user_id} {owner_id}
SetOwner
Sets owner id.
ns-access access setowner
--owner_id (String)
Product
List
Returns the product list
ns-access product list {filters} {page} {size} {sorts}
Get
Returns a product by an id
ns-access product get {id}
_Set
Sets all the required access of a product
ns-access product _set {product_id}
@row_option_text
<@row_option@>UserRole
_Set
Sets a user role if dose not exist.
ns-access userrole _set
--user_id (String)
--role_id (String)
Schemas
PermissionCategory
{ "name": "PermissionCategory", "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 } }}
PermissionField
{ "name": "PermissionField", "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 } }}
PermissionTag
{ "name": "PermissionTag", "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 } }}
Permission
{ "name": "Permission", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "to_user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "from_email": { "type": "String", "required": true }, "from_first_name": { "type": "String", "required": true, "max": 255 }, "from_last_name": { "type": "String", "required": true, "max": 255 }, "to_email": { "type": "String", "required": true }, "to_first_name": { "type": "String", "required": true, "max": 255 }, "to_last_name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
PermissionFull
{ "name": "PermissionFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "to_user_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "from_email": { "type": "String", "required": true }, "from_first_name": { "type": "String", "required": true, "max": 255 }, "from_last_name": { "type": "String", "required": true, "max": 255 }, "to_email": { "type": "String", "required": true }, "to_first_name": { "type": "String", "required": true, "max": 255 }, "to_last_name": { "type": "String", "required": true, "max": 255 }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "policies": { "type": "Array", "required": true, "items": [ { "type": "String", "required": false } ] }, "roles": { "type": "Array", "required": true, "items": [ { "type": "String", "required": false } ] }, "permission_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "permission_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 } } } ] }, "permission_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 } } } ] } }}
PermissionInput
{ "name": "PermissionInput", "type": "Object", "required": true, "fields": { "to_email": { "type": "String", "required": true }, "policies": { "type": "Array", "required": true, "items": [ { "type": "String", "required": false } ] }, "roles": { "type": "Array", "required": true, "items": [ { "type": "String", "required": false } ] }, "permission_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "permission_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 } } } ] }, "permission_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 } } } ] } }}
PolicyCategory
{ "name": "PolicyCategory", "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 } }}
PolicyField
{ "name": "PolicyField", "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 } }}
PolicyTag
{ "name": "PolicyTag", "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 } }}
Policy
{ "name": "Policy", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "entity": { "type": "String", "required": true, "max": 255 }, "actions": { "type": "String", "required": true }, "resources": { "type": "String", "required": true }, "allow": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
PolicyFull
{ "name": "PolicyFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "entity": { "type": "String", "required": true, "max": 255 }, "actions": { "type": "String", "required": true }, "resources": { "type": "String", "required": true }, "allow": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true }, "policy_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "policy_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 } } } ] }, "policy_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 } } } ] } }}
PolicyInput
{ "name": "PolicyInput", "type": "Object", "required": true, "fields": { "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "entity": { "type": "String", "required": true, "max": 255 }, "actions": { "type": "String", "required": true }, "resources": { "type": "String", "required": true }, "allow": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "policy_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "policy_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 } } } ] }, "policy_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 } } } ] } }}
RoleCategory
{ "name": "RoleCategory", "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 } }}
RoleField
{ "name": "RoleField", "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 } }}
RoleTag
{ "name": "RoleTag", "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 } }}
Role
{ "name": "Role", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "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 } }}
RoleFull
{ "name": "RoleFull", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "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 }, "policies": { "type": "Array", "required": true, "items": [ { "type": "String", "required": false } ] }, "role_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "role_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 } } } ] }, "role_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 } } } ] } }}
RoleInput
{ "name": "RoleInput", "type": "Object", "required": true, "fields": { "name": { "type": "String", "required": true, "max": 255 }, "description": { "type": "String", "required": false }, "policies": { "type": "Array", "required": true, "items": [ { "type": "String", "required": false } ] }, "role_category": { "type": "Array", "required": true, "items": [ { "name": "EntityCategoryInput", "type": "Object", "required": false, "fields": { "category_id": { "type": "String", "required": true, "min": 20, "max": 20 } } } ] }, "role_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 } } } ] }, "role_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 } } } ] } }}
Access
{ "name": "Access", "type": "Object", "required": true, "fields": { "user_id": { "type": "String", "required": true }, "owner_id": { "type": "String", "required": true }, "policies": { "type": "Array", "required": true, "items": [ { "name": "Policy", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "user_id": { "type": "String", "required": false, "min": 20, "max": 20 }, "product_id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "entity": { "type": "String", "required": true, "max": 255 }, "actions": { "type": "String", "required": true }, "resources": { "type": "String", "required": true }, "allow": { "type": "Boolean", "required": true }, "description": { "type": "String", "required": false }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } } } ] } }}
Product
{ "name": "Product", "type": "Object", "required": true, "fields": { "id": { "type": "String", "required": true, "min": 20, "max": 20 }, "name": { "type": "String", "required": true, "max": 255 }, "access": { "type": "Any", "required": true }, "created_at": { "type": "DateTime", "required": true }, "updated_at": { "type": "DateTime", "required": true } }}
Enums
Namira Software Corporation
©Copyright 2010 to 2025 Namira Software Corporation. All rights reserved.