Namirasoft Access API V1

Namira Software Corporation Access API Version 1 (1.5.1)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-access-api-v1

Copied!

Commands


Health

Liveness

Returns the application liveness status

ns-access health liveness

Copied!

Readiness

Returns the application readiness status

ns-access health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-access metrics get

Copied!

Value

List

Returns the value list of a given table and column

ns-access 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-access overview count

Copied!

--group_by_workspace (Boolean)

--workspace_ids (Array)

PermissionCategory

List

Returns the permission category list

ns-access permissioncategory list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a permission category by id.

ns-access permissioncategory get {id}

Copied!

Create

Creates a new permission category for an entity

ns-access permissioncategory create

Copied!

--slot_id (String)

--category_id (String)

Delete

Deletes a permission category by an id.

ns-access permissioncategory delete {id}

Copied!

PermissionField

List

Returns the permission field list

ns-access permissionfield list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a permission field by id.

ns-access permissionfield get {id}

Copied!

Create

Creates a new permission field for an entity

ns-access permissionfield create

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Update

Updates a permission field by an id for an entity

ns-access permissionfield update {id}

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a permission field by an id.

ns-access permissionfield delete {id}

Copied!

PermissionTag

List

Returns the permission tag list

ns-access permissiontag list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a permission tag by id.

ns-access permissiontag get {id}

Copied!

Create

Creates a new permission tag for an entity

ns-access permissiontag create

Copied!

--name (String)

--value (String)

Update

Updates a permission tag by an id for an entity

ns-access permissiontag update {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a permission tag by an id.

ns-access permissiontag delete {id}

Copied!

Permission

List

Returns the permission list

ns-access permission list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

ListOutgoing

Returns the outgoing permission list

ns-access permission listoutgoing {filters} {page} {size} {sorts} {all_workspaces}

Copied!

ListIncoming

Returns the incoming permission list

ns-access permission listincoming {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a permission by an id

ns-access permission get {id}

Copied!

GetIncoming

Returns an incoming permission by an id

ns-access permission getincoming {id}

Copied!

GetOutgoing

Returns an outgoing permission by an id

ns-access permission getoutgoing {id}

Copied!

Create

Creates a new permission

ns-access permission create

Copied!

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

Copied!

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

Copied!

DeleteIncoming

Deletes an incoming permission by an id

ns-access permission deleteincoming {id}

Copied!

PolicyCategory

List

Returns the policy category list

ns-access policycategory list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a policy category by id.

ns-access policycategory get {id}

Copied!

Create

Creates a new policy category for an entity

ns-access policycategory create

Copied!

--slot_id (String)

--category_id (String)

Delete

Deletes a policy category by an id.

ns-access policycategory delete {id}

Copied!

PolicyField

List

Returns the policy field list

ns-access policyfield list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a policy field by id.

ns-access policyfield get {id}

Copied!

Create

Creates a new policy field for an entity

ns-access policyfield create

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Update

Updates a policy field by an id for an entity

ns-access policyfield update {id}

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a policy field by an id.

ns-access policyfield delete {id}

Copied!

PolicyTag

List

Returns the policy tag list

ns-access policytag list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a policy tag by id.

ns-access policytag get {id}

Copied!

Create

Creates a new policy tag for an entity

ns-access policytag create

Copied!

--name (String)

--value (String)

Update

Updates a policy tag by an id for an entity

ns-access policytag update {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a policy tag by an id.

ns-access policytag delete {id}

Copied!

Policy

List

Returns the policy list

ns-access policy list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

ListIncoming

Returns the incoming policy list

ns-access policy listincoming {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a policy by an id

ns-access policy get {id}

Copied!

GetIncoming

Returns an incoming policy by an id

ns-access policy getincoming {id}

Copied!

Create

Creates a new policy

ns-access policy create

Copied!

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

Copied!

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

Copied!

RoleCategory

List

Returns the role category list

ns-access rolecategory list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a role category by id.

ns-access rolecategory get {id}

Copied!

Create

Creates a new role category for an entity

ns-access rolecategory create

Copied!

--slot_id (String)

--category_id (String)

Delete

Deletes a role category by an id.

ns-access rolecategory delete {id}

Copied!

RoleField

List

Returns the role field list

ns-access rolefield list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a role field by id.

ns-access rolefield get {id}

Copied!

Create

Creates a new role field for an entity

ns-access rolefield create

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Update

Updates a role field by an id for an entity

ns-access rolefield update {id}

Copied!

--slot_id (String)

--field_id (String)

--value (Any)

Delete

Deletes a role field by an id.

ns-access rolefield delete {id}

Copied!

RoleTag

List

Returns the role tag list

ns-access roletag list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a role tag by id.

ns-access roletag get {id}

Copied!

Create

Creates a new role tag for an entity

ns-access roletag create

Copied!

--name (String)

--value (String)

Update

Updates a role tag by an id for an entity

ns-access roletag update {id}

Copied!

--name (String)

--value (String)

Delete

Deletes a role tag by an id.

ns-access roletag delete {id}

Copied!

Role

List

Returns the role list

ns-access role list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

ListIncoming

Returns the incoming role list

ns-access role listincoming {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a role by an id

ns-access role get {id}

Copied!

GetIncoming

Returns an incoming role by an id

ns-access role getincoming {id}

Copied!

Create

Creates a new role

ns-access role create

Copied!

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

Copied!

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

Copied!

Access

_GetFor

Returns an access for an user_id

ns-access access _getfor {user_id} {owner_id}

Copied!

SetOwner

Sets owner id.

ns-access access setowner

Copied!

--owner_id (String)

Product

List

Returns the product list

ns-access product list {filters} {page} {size} {sorts} {all_workspaces}

Copied!

Get

Returns a product by an id

ns-access product get {id}

Copied!

_Set

Sets all the required access of a product

ns-access product _set {product_id}

Copied!
<@row_option>

@row_option_text

<@row_option@>

UserRole

_Set

Sets a user role if dose not exist.

ns-access userrole _set

Copied!

--user_id (String)

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

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

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

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": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "permission_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
                        }
                    }
                }
            ]
        },
        "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": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "permission_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
                        }
                    }
                }
            ]
        },
        "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
        },
        "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
        }
    }
}

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

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": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "policy_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
                        }
                    }
                }
            ]
        },
        "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": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "policy_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
                        }
                    }
                }
            ]
        },
        "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
        },
        "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
        }
    }
}

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

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": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "role_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
                        }
                    }
                }
            ]
        },
        "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": {
                        "slot_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        },
                        "category_id": {
                            "type": "String",
                            "required": true,
                            "min": 20,
                            "max": 20
                        }
                    }
                }
            ]
        },
        "role_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
                        }
                    }
                }
            ]
        },
        "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
        },
        "entities": {
            "type": "Any",
            "required": true
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

Enums

Namira Software Corporation

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