fully-api

{ "models": [ { "name": "fsapi_user", "db_table": "fsapi_user", "description": "user entity", "date_created": "2021-08-13", "date_updated": "2021-08-13", "updated_date": "2021-08-13", "security_roles": [ "super" ], "properties": [ { "name": "id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "This is a system generated field. It is a unique identifier for a record." }, { "name": "firstname", "required": true, "data_type": "string", "editable": true, "nullable": false, "description": "first name" }, { "name": "lastname", "required": true, "data_type": "string", "editable": true, "nullable": false, "description": "last name" }, { "name": "email", "required": true, "data_type": "string", "editable": true, "nullable": false, "description": "last name" }, { "name": "username", "required": false, "data_type": "string", "editable": true, "nullable": false, "description": "last name" }, { "name": "phone_number", "required": false, "data_type": "string", "editable": true, "nullable": true, "description": "last name" }, { "name": "phone_country_code", "required": false, "data_type": "string", "editable": true, "nullable": true, "description": "last name" }, { "name": "is_active", "required": true, "data_type": "boolean", "editable": true, "nullable": false, "description": "is this user account active (soft deleted when false)" }, { "name": "is_locked", "required": true, "data_type": "boolean", "editable": true, "nullable": false, "description": "is this user account locked and restricted from logging in" }, { "name": "created_at", "required": true, "data_type": "boolean", "editable": false, "nullable": false, "description": "timestamp of creation" }, { "name": "updated_at", "required": false, "data_type": "boolean", "editable": true, "nullable": false, "description": "timestamp of last update" }, { "name": "data", "required": false, "data_type": "json", "editable": true, "nullable": true, "description": "metadata" } ] }, { "name": "fsapi_user_auth", "db_table": "fsapi_user_auth", "description": "user sensitive into storage entity", "date_created": "2021-08-13", "date_updated": "2021-08-13", "updated_date": "2021-08-13", "security_roles": [ "super" ], "properties": [ { "name": "id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "This is a system generated field. It is a unique identifier for a record." }, { "name": "user_id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "links record to the associated fsapi_user record." }, { "name": "password", "required": true, "data_type": "string", "editable": true, "nullable": false, "description": "first name" }, { "name": "client_secret", "required": false, "data_type": "string", "editable": true, "nullable": true, "description": "last name" }, { "name": "forgot_password_tokens", "required": false, "data_type": "array", "editable": true, "nullable": true, "description": "forgot password tokens" }, { "name": "salt", "required": true, "data_type": "string", "editable": true, "nullable": false, "description": "sensitive data salt value" }, { "name": "security_roles", "required": false, "data_type": "array", "editable": true, "nullable": false, "description": "what security roles/permissions does this user have for accessing endpoints" }, { "name": "is_active", "required": true, "data_type": "boolean", "editable": true, "nullable": false, "description": "is this user account active (soft deleted when false)" }, { "name": "created_at", "required": true, "data_type": "boolean", "editable": false, "nullable": false, "description": "timestamp of creation" }, { "name": "data", "required": false, "data_type": "json", "editable": true, "nullable": true, "description": "metadata" } ] }, { "name": "fsapi_session", "db_table": "fsapi_session", "description": "user session info", "date_created": "2021-08-13", "date_updated": "2021-08-13", "updated_date": "2021-08-13", "security_roles": [ "super" ], "properties": [ { "name": "id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "This is a system generated field. It is a unique identifier for a record." }, { "name": "user_id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "links record to the associated fsapi_user record." }, { "name": "token", "required": true, "data_type": "string", "editable": false, "nullable": false, "description": "request header auth token" }, { "name": "salt", "required": true, "data_type": "string", "editable": false, "nullable": false, "description": "sensitive data salt value" }, { "name": "security_roles", "required": false, "data_type": "array", "editable": true, "nullable": false, "description": "what security roles/permissions does this user have for accessing endpoints" }, { "name": "is_active", "required": true, "data_type": "boolean", "editable": true, "nullable": false, "description": "is this user account active (soft deleted when false)" }, { "name": "is_anonymous", "required": false, "data_type": "boolean", "editable": true, "nullable": false, "description": "is this session an anonymous user session" }, { "name": "created_at", "required": true, "data_type": "boolean", "editable": false, "nullable": false, "description": "timestamp of creation" }, { "name": "updated_at", "required": true, "data_type": "boolean", "editable": true, "nullable": false, "description": "timestamp of last update" }, { "name": "last_touch", "required": true, "data_type": "boolean", "editable": true, "nullable": false, "description": "timestamp of last api interaction during this user session" }, { "name": "client_info", "required": false, "data_type": "json", "editable": true, "nullable": true, "description": "metadata" }, { "name": "data", "required": false, "data_type": "json", "editable": true, "nullable": true, "description": "metadata" } ] }, { "name": "fsapi_user_session", "db_table": "fsapi_user_session", "description": "user session linking table", "date_created": "2021-08-13", "date_updated": "2021-08-13", "updated_date": "2021-08-13", "security_roles": [ "super" ], "properties": [ { "name": "id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "This is a system generated field. It is a unique identifier for a record." }, { "name": "user_id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "links record to the associated fsapi_user record." }, { "name": "session_id", "data_type": "string", "required": true, "editable": false, "nullable": false, "description": "links record to the associated fsapi_session record." }, { "name": "rel_type", "required": true, "data_type": "string", "editable": true, "nullable": false, "description": "relationship type marker. defaults for \"default\"" }, { "name": "created_at", "required": true, "data_type": "boolean", "editable": false, "nullable": false, "description": "timestamp of creation" }, { "name": "data", "required": false, "data_type": "json", "editable": true, "nullable": true, "description": "metadata" } ] } ] }