Designed to be easily extensible, Core REST Services aims to provide a REST interface to common data center functions. Many organizations continue to adopt next-gen iPaaS platforms to automate processes and remove manual "swivel-chair" data entry across multiple systems. However, most organizations are still tied to some "legacy" systems that do not provide a modern way to access them. This project (hopefully) will make it easier to include these systems in their process automation efforts.
* Includes both API Key and JWT schemes (API Key enabled by default)
* Access to common filesystem operations
* Directories should be separated as "\", NOT "\" so as not to wreck the whole URI thing
* Does not support getting files with a "." as the first character (i.e. ".env") on Windows
* Run a command line function and either return immediately or wait to retrieve the response back
* Common AD functions, mostly centered around user management
* Create keys and encrypt and decrypt files
* node v14+
* maybe others
* Clone this project or download the zip file and extract it into a folder
* On the command line, execute `npm install`
See the configuration file guide for configuration options
* To install and start the service - `npm run winSvc install`
* To uninstall the service - `npm run winSvc uninstall`
* Start the service - `npm run winSvc start`
* Start the service - `npm run winSvc stop`
* On the command line, execute `npm run start`
* By default, HTTPS server starts on port 4000
* The default API Key is located in the `.env` file in the root directory of this project. I HIGHLY reccomend changing it immediately.
* The default certificates used for HTTPS are simple, self-signed certs. I HIGHLY reccomend changing these immediately.
* Open a browser window to https://host:port/api-docs to view the documentation on each endpoint
* NODE_ENV: the environment this server is running in. Warning: If set to PROD, the OAS documentation will not be auto-generated
* HTTPS: Boolean (true | false) turns on HTTPS support
* PORT: The port to open for HTTP traffic
* SERVER_CERT: path to the server's public certificate (you should change this immediately)
* SERVER_KEY: path to the server's private key (you should change this immediately)
Leaving any of these blank will use the default "Local System" as the user
* WIN_SVC_DOMAIN: The domain for the "LogInAs" user for the service
* WIN_SVC_ACCOUNT: The "LogInAs" user for the service
* WIN_SVC_PASSWORD: Password for the user
* API_KEY = The key to provide for authentication in the "api-key" header
* ACCESS_TOKEN_SECRET: the "Authentication" header must contain "Bearer <token>"
* LOG_TO_CONSOLE: Boolean (true | false) to control logging traffic to the console. Logging will never happen if NODE_ENV is set to 'production' or 'PROD'
* LOG_LEVELS: (access,error,warn,info,debug) sets the log level to output
* LOG_FILE_DIR: directory to create log files
* LOG_FILE_BASE_NAME: base filename for the log files
This provides a REST interface to an on-prem Active Directory instance. Ensure that secure communications are enabled to AD to enable certain operations through this service (i.e. passwords)
* AD_URL: the URL to connect the service to (ldaps is highly reccomended) i.e. ldaps://host:port
* AD_PRINCIPAL: this is in email format (i.e. [email protected])
* AD_CREDENTIALS = password for the principal user id
* PGP_PASSPHRASE: The passphrase to decrypt files sent to you
* PGP_PUBLIC_KEY: The ASCII-armored public key (surround in double quotes) for signing
* PGP_PRIVATE_KEY: The ASCII-armored private key (surround in double quotes) for decrypting
Check the API Docs here: https://host:port/api-docs
If that does not address your issues, please log a ticket
Contributors names and contact info
- 0.1
- Initial Release
This project is licensed under the MIT License - see the LICENSE.md file for details
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent