Initial commit
This commit is contained in:
Isaac Parenteau committed
commit
880e39de2e
511 files changed
+38363
No files matched your search
@@ -0,0 +1,99 @@
|
||||
\section{Account API}
|
||||
This section documents api calls that are associated with user accounts.
|
||||
|
||||
\subsection{Is Logged In}
|
||||
The following will check if the user is logged into the system. It would be for the local user, not a specified user. Each time a user logs in, the user is assiged a token. This method call checks to see if that token is present for that user.
|
||||
\begin{apimethod}
|
||||
{User Is Logged In}
|
||||
{account/isLoggedIn.do}
|
||||
{POST}
|
||||
{No}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/isLoggedInResp}}
|
||||
|
||||
\subsection{Login}
|
||||
The following method allows a user to log into the application
|
||||
\begin{apimethod}
|
||||
{Login}
|
||||
{account/login.do}
|
||||
{POST}
|
||||
{No}
|
||||
\begin{itemize}
|
||||
\item \Required{username}{Email of the user to login}
|
||||
\item \Required{password}{password of the user}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/loginReq}}{\input{api/sample/response/loginResp}}
|
||||
|
||||
\subsection{Logout}
|
||||
The following method logs the current user out
|
||||
\begin{apimethod}
|
||||
{Logout}
|
||||
{account/logout.do}
|
||||
{POST}
|
||||
{No}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/None}}
|
||||
|
||||
\subsection{Add User}
|
||||
The following method adds a user to the server
|
||||
\begin{apimethod}
|
||||
{Add User}
|
||||
{account/addUser.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{email}{Email associated with the user for login}
|
||||
\item \Required{password}{Default password for the user to login with}
|
||||
\item \Required{role}{Role the user belongs to}
|
||||
\item \Optional{firstName}{First name of the user to add}
|
||||
\item \Optional{lastName}{Last name of the user to add}
|
||||
\item \Optional{effectiveDate}{Date in which the user goes into effect (can acess site)}
|
||||
\item \Optional{expirationDate}{Date in which the user loses access to the site}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addUserReq}}{\input{api/sample/response/addUserResp}}
|
||||
|
||||
\subsection{Delete User}
|
||||
The following method removes a user from the server
|
||||
\begin{apimethod}
|
||||
{Delete User}
|
||||
{account/deleteUser.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{email}{Email associated with the user to delete}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteUserReq}}{\input{api/sample/SuccessResp}}
|
||||
|
||||
\subsection{Get All Users}
|
||||
The following method gets a list of all users (active and inactive) for the application
|
||||
\begin{apimethod}
|
||||
{Get All Users}
|
||||
{account/getAll.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getAllUsersResp}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
\section{Application Log API}
|
||||
This section documents api calls that are associated with the application logs
|
||||
|
||||
\subsection{Get All Logs}
|
||||
The following method gets a list of all the application logs
|
||||
\begin{apimethod}
|
||||
{Get All Logs}
|
||||
{logs/getAll.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getAllLogsResp}}
|
||||
|
||||
\subsection{Purge Logs}
|
||||
The following method purges logs between the start date and end date
|
||||
\begin{apimethod}
|
||||
{Purge Logs}
|
||||
{logs/purge.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{purgeStartDate}{Starting date to purge logs from}
|
||||
\item \Required{purgeEndDate}{Ending date to purge logs from}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/purgeLogReq}}{\input{api/sample/response/purgeLogResp}}
|
||||
@@ -0,0 +1,55 @@
|
||||
\section{Configuration API}
|
||||
|
||||
This section documents api calls that are associated with configuration settings.
|
||||
|
||||
\subsection{Get Configuration Value}
|
||||
The following will get a specified configuration value if that value is present in the server configuration
|
||||
\begin{apimethod}
|
||||
{Get Configuration Value}
|
||||
{config/getConfigurationValue.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{key}{Name of the configuration Value to retrieve}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/getConfValReq}}{\input{api/sample/response/getConfValResp}}
|
||||
|
||||
\subsection{Get Configuration}
|
||||
The following will get the current configuration values associated with the server as specified in the file \filename{\$TOMCAT\_HOME/conf/portal.properties}
|
||||
\begin{apimethod}
|
||||
{Get Configuration}
|
||||
{config/getConfiguration.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getConfResp}}
|
||||
|
||||
\subsection{Save Configuration}
|
||||
The following will save the server configuration values to \filename{\$TOMCAT\_HOME/conf/portal.properties}. All the parameters are option as they all do not need to be populated, just the ones that need to be changed
|
||||
\begin{apimethod}
|
||||
{Save Configuration}
|
||||
{config/saveConfiguration.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Optional{filepath}{File path to where the files are stored on the server}
|
||||
\item \Optional{dbUsername}{Username granted access to the portal tables}
|
||||
\item \Optional{dbPassword}{Password for the portal database user}
|
||||
\item \Optional{dbRootUser}{Root username for the database.}
|
||||
\item \Optional{dbRootPassword}{Password for the root user for the database}
|
||||
\item \Optional{dbHost}{URL or IP address for the database server}
|
||||
\item \Optional{dbPort}{Database port to connect on}
|
||||
\item \Optional{userExpirationDays}{Default number of days until a new user account expires}
|
||||
\item \Optional{logLevel}{Default log level that new loggers initialize with}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/response/getConfResp}}{\input{api/sample/SuccessResp}}
|
||||
|
||||
|
||||
@@ -0,0 +1,89 @@
|
||||
\section{Credentials API}
|
||||
This section documents api calls that are associated with script and git credentials.
|
||||
|
||||
\subsection{Get All Credentials}
|
||||
The following will get all the available credentials
|
||||
|
||||
\begin{apimethod}
|
||||
{Get All Credentials}
|
||||
{creds/do.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getAllCredsResp}}
|
||||
|
||||
\subsection{Get Credential Types}
|
||||
The following will get the available credential types allowed.
|
||||
|
||||
\begin{apimethod}
|
||||
{Get Credential Types}
|
||||
{creds/getCredentialTypes.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getCredTypesResp}}
|
||||
|
||||
\subsection{Add/Edit Credentials (Username/Password)}
|
||||
The following will add/edit username and password credentials to the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Add/Edit Credentials (Username/Password)}
|
||||
{creds/add.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name for the credentials}
|
||||
\item \Required{credentialType}{``PASSWD''}
|
||||
\item \Required{username}{Username to add}
|
||||
\item \Required{password}{Password of the user}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addCredUnameReq}}{\input{api/sample/response/addCredUnameResp}}
|
||||
|
||||
\subsection{Add/Edit Credentials (SSH Key)}
|
||||
The following will add/edit a ssh key to the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Add/Edit Credentials (SSH Key)}
|
||||
{creds/add.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name for the credentials}
|
||||
\item \Required{credentialType}{``SSH''}
|
||||
\item \Required{username}{Identity of the user who the key belongs to}
|
||||
\item \Required{key}{SSH private key}
|
||||
\item \Optional{passphrase}{Passphrase for the ssh key}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addCredSshKeyReq}}{\input{api/sample/response/addCredSshKeyResp}}
|
||||
|
||||
\subsection{Delete Credentials}
|
||||
The following will delete credentials from the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Delete Credentials}
|
||||
{creds/delete.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{uid}{Unique identifier of the credentials}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteCredsReq}}{\input{api/sample/response/deleteCredsResp}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
\section{File API}
|
||||
This section documents api calls associated with the patch files
|
||||
|
||||
\subsection{Download File}
|
||||
The following will allow to download a file
|
||||
\begin{apimethod}
|
||||
{Download File}
|
||||
{file/download.do}
|
||||
{GET}
|
||||
{No}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{Id of the file to download}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
Sample GET request\newline
|
||||
\command{https://portal.viprcenter.com/portal/file/download.do?id=2}
|
||||
|
||||
\subsection{Delete File}
|
||||
The following will delete a file from the server
|
||||
\begin{apimethod}
|
||||
{Delete File}
|
||||
{file/delete.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{The ID of the file to delete}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteFileReq}}{\input{api/sample/SuccessResp}}
|
||||
@@ -0,0 +1,73 @@
|
||||
\section{Git API}
|
||||
This section documents api calls that are associated with git repositories.
|
||||
|
||||
\subsection{Get All Repositories}
|
||||
The following will get all the available git repositories
|
||||
|
||||
\begin{apimethod}
|
||||
{Get All Repositories}
|
||||
{git/getAll.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getAllReposResp}}
|
||||
|
||||
\subsection{Add/Edit Git Repository}
|
||||
The following will add/edit a git repository
|
||||
|
||||
\begin{apimethod}
|
||||
{Add/Edit Git Repository}
|
||||
{git/add.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name of the repository}
|
||||
\item \Required{scm}{The git repository url to clone}
|
||||
\item \Required{branch}{The branch to checkout}
|
||||
\item \Required{directory}{Local directory to clone into (doesn't need to exist)}
|
||||
\item \Required{credentials}{The credentials to use. Requires the following:}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{uid}{Unique identifer of the credentials to use.}
|
||||
\end{itemize}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addGitRepoReq}}{\input{api/sample/response/addGitRepoResp}}
|
||||
|
||||
\subsection{Pull Repository}
|
||||
The following will issue a pull command to the desired repository
|
||||
|
||||
\begin{apimethod}
|
||||
{Pull Repository}
|
||||
{git/pull.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{Id of the repository to pull}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteGitRepoReq}}{\input{api/sample/response/addGitRepoResp}}
|
||||
|
||||
\subsection{Delete Git Repository}
|
||||
The following will delete a git repository
|
||||
|
||||
\begin{apimethod}
|
||||
{Delete Git Repository}
|
||||
{git/delete.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{Id of the repository to delete}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteGitRepoReq}}{\input{api/sample/response/addGitRepoResp}}
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
\section{Logger API}
|
||||
This section documents api calls associated with the application loggers
|
||||
|
||||
\subsection{Get Loggers}
|
||||
The following will get a list of the current loggers and their log levels
|
||||
|
||||
\begin{apimethod}
|
||||
{Get Loggers}
|
||||
{logger/getLoggers.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getLoggersResp}}
|
||||
|
||||
\subsection{Set Loggers}
|
||||
The following will set the current loggers to the selected log level.
|
||||
|
||||
NOTE: the request body parameters are in a list
|
||||
|
||||
\begin{apimethod}
|
||||
{Set Loggers}
|
||||
{logger/setLoggers.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{logger}{The Logger to set the log level to}
|
||||
\item \Required{level}{The level to set the logging to}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/response/getLoggersResp}}{\input{api/sample/SuccessResp}}
|
||||
@@ -0,0 +1,121 @@
|
||||
\section{Permission API}
|
||||
|
||||
This section documents api calls that are associated with defining permissions
|
||||
|
||||
\subsection{Add Permission Category}
|
||||
|
||||
The following section will describe adding a permission category
|
||||
|
||||
\begin{apimethod}
|
||||
{Add Permission Category}
|
||||
{permissions/updatePermissionCategory.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name of the permission group }
|
||||
\item \Required{displayName}{Name to be displayed in the permissions list}
|
||||
\item \Required{enabled}{Whether or not the permission group is enabled}
|
||||
\item \Required{permissions}{permissions to add. The allowed permissions area aleady predefined by the server. Below are the required parameters that have to be set inside the permissions list.\newline \begin{itemize}
|
||||
\item \Required{permissionId}{Id of the permission to add}
|
||||
\item \Required{allowed}{whether or not the permission is enabled or not}
|
||||
\end{itemize}}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addPermGroupReq}}{\input{api/sample/response/addPermGroupResp}}
|
||||
|
||||
\subsection{Update Permission Category}
|
||||
|
||||
The following section will describe updating a permission category
|
||||
|
||||
\begin{apimethod}
|
||||
{Update Permission Category}
|
||||
{permissions/updatePermissionCategory.do}
|
||||
{POST}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name of the permission group }
|
||||
\item \Required{enabled}{Whether or not the permission group is enabled}
|
||||
\item \Required{permissions}{permissions to add. The allowed permissions area aleady predefined by the server.
|
||||
Below are the required parameters that have to be set inside the permissions list.\newline
|
||||
\begin{itemize}
|
||||
\item \Required{permissionId}{Id of the permission to add}
|
||||
\item \Required{allowed}{whether or not the permission is enabled or not}
|
||||
\end{itemize}}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/updatePermGroupReq}}{\input{api/sample/response/addPermGroupResp}}
|
||||
|
||||
\subsection{Get Permission Groups}
|
||||
|
||||
The following section will get permission groups with their associative permissions
|
||||
|
||||
\begin{apimethod}
|
||||
{Get Permission Groups}
|
||||
{permissions/getPermissionGroups.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getPermGroupResp}}
|
||||
|
||||
\subsection{Get All Permission Groups}
|
||||
|
||||
The following section will get permission groups only. Will not show the actual permissions
|
||||
|
||||
\begin{apimethod}
|
||||
{Get All Permission Groups}
|
||||
{permissions/getPermissionGroups.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getAllPermsResp}}
|
||||
|
||||
\subsection{Get Permission Categories}
|
||||
|
||||
The following section will get the different permission categories and the permissions associated with the category
|
||||
|
||||
\begin{apimethod}
|
||||
{Get All Permission Groups}
|
||||
{permissions/getPermissionGroups.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getPermCatResp}}
|
||||
|
||||
\subsection{Delete Permission Group}
|
||||
|
||||
The following section will delete a selected permission group. The return value is the deleted group
|
||||
|
||||
Note: The permission group has to be empty. No user can be long to the group to be deleted otherwise an error will be returned
|
||||
|
||||
\begin{apimethod}
|
||||
{Get All Permission Groups}
|
||||
{permissions/deletePermissionGroup.do}
|
||||
{GET}
|
||||
{Yes}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Permission group name to be deleted}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deletePermGroupReq}}{\input{api/sample/response/deletePermGroupResp}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,290 @@
|
||||
\section{Scripts API}
|
||||
This section documents api calls that are associated with creating and maintaining scripts.
|
||||
|
||||
\subsection{Get All Scripts}
|
||||
The following will get all the available scripts
|
||||
|
||||
\begin{apimethod}
|
||||
{Get All Scripts}
|
||||
{scripts/getAll.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getAllScriptsResp}}
|
||||
|
||||
\subsection{Get Schedule Frequency}
|
||||
The following will get a list of the available schedule frequencies
|
||||
|
||||
\begin{apimethod}
|
||||
{Get Get Schedule Frequency}
|
||||
{scripts/getScheduleFrequencies.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getScheduleFreqResp}}
|
||||
|
||||
\subsection{Get Script Type}
|
||||
The following will get a list of the types of scripts that can be created
|
||||
|
||||
\begin{apimethod}
|
||||
{Get Script Type}
|
||||
{scripts/getScriptType.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getScriptTypesResp}}
|
||||
|
||||
\subsection{Add Script Local}
|
||||
\label{add-script-Local}
|
||||
The following will a a local script to the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Add Script Local}
|
||||
{scripts/addScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name of the script}
|
||||
\item \Required{scriptType}{``LOCAL''}
|
||||
\item \Required{command}{The command to execute}
|
||||
\item \Optional{baseDirectory}{Local directory to start the command in}
|
||||
\item \Optional{outputDirectory}{Directory to place any output into}
|
||||
\item \Optional{parameters}{Paremetrs to be used with the command}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{parameter}{The parameter to be used}
|
||||
\end{itemize}
|
||||
\item \Optional{schedule}{Time and frequency the script should execute}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{frequency}{How often the script should trigger}
|
||||
\item \Required{startDatetime}{When the schedule should start to trigger}
|
||||
\item \Optional{endDatetime}{When the schedule should end}
|
||||
\item \Optional{maxExecution}{Number of executions before schedule stops}
|
||||
\end{itemize}
|
||||
\Optional{scriptVariables}{Environment variables specific to the script}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Name of the variable}
|
||||
\item \Required{value}{Value of the variable}
|
||||
\end{itemize}
|
||||
\Optional{scriptChain}{Follow-on scripts to execute after parent script finishes}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{childScript}{Id of the child script to execute}
|
||||
\item \Required{exitStatus}{Exit status of the parent to trigger child script}
|
||||
\end{itemize}
|
||||
\Optional{scriptEmails}{Email to send once script finishes}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{emailName}{Name of the email template to send}
|
||||
\item \Required{recipients}{List of recipients to send the email to. Requires email address}
|
||||
\end{itemize}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addScriptLocalReq}}{\input{api/sample/response/addScriptLocalResp}}
|
||||
|
||||
\subsection{Update Script Local}
|
||||
|
||||
The following will update a local script on the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Update Script Local}
|
||||
{scripts/updateScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
See section~\ref{add-script-Local} for acceptable parameters and response
|
||||
\end{apimethod}
|
||||
|
||||
\subsection{Add Script Remote}
|
||||
\label{add-script-remote}
|
||||
The following will a remote script to the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Add Script Remote}
|
||||
{scripts/addScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name of the script}
|
||||
\item \Required{scriptType}{``REMOTE''}
|
||||
\item \Required{remote}{The remote connection information}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{scriptCredentials}{The uid of the credentials to use}
|
||||
\item \Required{url}{the IP address or url to connect to}
|
||||
\item \Required{port}{The port to connect to}
|
||||
\end{itemize}
|
||||
\item \Optional{baseDirectory}{Remote directory to start the command in}
|
||||
\item \Optional{outputDirectory}{Directory to place any output into}
|
||||
\item \Optional{parameters}{Paremetrs to be used with the command}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{parameter}{The parameter to be used}
|
||||
\end{itemize}
|
||||
\item \Optional{schedule}{Time and frequency the script should execute}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{frequency}{How often the script should trigger}
|
||||
\item \Required{startDatetime}{When the schedule should start to trigger}
|
||||
\item \Optional{endDatetime}{When the schedule should end}
|
||||
\item \Optional{maxExecution}{Number of executions before schedule stops}
|
||||
\end{itemize}
|
||||
\Optional{scriptVariables}{Environment variables specific to the script}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Name of the variable}
|
||||
\item \Required{value}{Value of the variable}
|
||||
\end{itemize}
|
||||
\Optional{scriptChain}{Follow-on scripts to execute after parent script finishes}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{childScript}{Id of the child script to execute}
|
||||
\item \Required{exitStatus}{Exit status of the parent to trigger child script}
|
||||
\end{itemize}
|
||||
\Optional{scriptEmails}{Email to send once script finishes}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{emailName}{Name of the email template to send}
|
||||
\item \Required{recipients}{List of recipients to send the email to. Requires email address}
|
||||
\end{itemize}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addScriptRemoteReq}}{\input{api/sample/response/addScriptRemoteResp}}
|
||||
|
||||
\subsection{Update Script Remote}
|
||||
|
||||
The following will update a remote script on the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Update Script Remote}
|
||||
{scripts/updateScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
See section~\ref{add-script-remote} for acceptable parameters and response
|
||||
\end{apimethod}
|
||||
|
||||
\subsection{Add Script Scp}
|
||||
\label{add-script-scp}
|
||||
The following will a scp script to the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Add Script Scp}
|
||||
{scripts/addScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name of the script}
|
||||
\item \Required{scriptType}{``SCP''}
|
||||
\item \Required{scp}{The remote connection information}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{fromCredentials}{The uid of the credentials for the machine retriving file from}
|
||||
\item \Required{fromHost}{the IP address or url to connect to or ``LOCAL'' if the file is from the server}
|
||||
\item \Required{fromPort}{The port to connect to or 0 if the file is ``LOCAL''}
|
||||
\item \Required{toCredentials}{The uid of the credentials for the machine the files are being sent to}
|
||||
\item \Required{toHost}{the IP address or url to connect to or ``LOCAL'' to store files on the server}
|
||||
\item \Required{toPort}{The port to connect to or 0 if the file is being saved ``LOCAL''}
|
||||
\end{itemize}
|
||||
\item \Optional{baseDirectory}{Remote to look for the file}
|
||||
\item \Optional{outputDirectory}{Directory to place any files into}
|
||||
\item \Optional{schedule}{Time and frequency the script should execute}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{frequency}{How often the script should trigger}
|
||||
\item \Required{startDatetime}{When the schedule should start to trigger}
|
||||
\item \Optional{endDatetime}{When the schedule should end}
|
||||
\item \Optional{maxExecution}{Number of executions before schedule stops}
|
||||
\end{itemize}
|
||||
\Optional{scriptChain}{Follow-on scripts to execute after parent script finishes}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{childScript}{Id of the child script to execute}
|
||||
\item \Required{exitStatus}{Exit status of the parent to trigger child script}
|
||||
\end{itemize}
|
||||
\Optional{scriptEmails}{Email to send once script finishes}\newline
|
||||
\begin{itemize}
|
||||
\item \Required{emailName}{Name of the email template to send}
|
||||
\item \Required{recipients}{List of recipients to send the email to. Requires email address}
|
||||
\end{itemize}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addScriptScpReq}}{\input{api/sample/response/addScriptScpResp}}
|
||||
|
||||
\subsection{Update Script Remote}
|
||||
|
||||
The following will update a scp script on the system
|
||||
|
||||
\begin{apimethod}
|
||||
{Update Script Scp}
|
||||
{scripts/updateScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
See section~\ref{add-script-scp} for acceptable parameters and response
|
||||
\end{apimethod}
|
||||
|
||||
\subsection{Manual Run Script}
|
||||
The following will manually run a script
|
||||
|
||||
\begin{apimethod}
|
||||
{Manually Run Script}
|
||||
{scripts/runScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{Id of the script to run}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/runScriptReq}}{\input{api/sample/response/addScriptLocalResp}}
|
||||
|
||||
\subsection{Delete Script}
|
||||
The following will delete a script
|
||||
|
||||
\begin{apimethod}
|
||||
{Delete Script}
|
||||
{scripts/deleteScript.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{Id of the script to delete}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/runScriptReq}}{\input{api/sample/response/addScriptLocalResp}}
|
||||
|
||||
\subsection{Delete Script Schedule}
|
||||
The following will delete a script schedule from a script
|
||||
|
||||
\begin{apimethod}
|
||||
{Delete Script Schedule}
|
||||
{scripts/deleteScriptSchedule.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{jobId}{Unique job identifier of the schedule to delete}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteScriptScheduleReq}}{\input{api/sample/response/deleteScriptScheduleResp}}
|
||||
|
||||
\subsection{Get Script Schedule Status Results}
|
||||
The following will get the results of the the schedule
|
||||
|
||||
\begin{apimethod}
|
||||
{Get Script Schedule Status Results}
|
||||
{scripts/getScriptScheduleStatus.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item uuid
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/getScriptStatusReq}}{\input{api/sample/response/getScriptScheduleStatusResp}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,200 @@
|
||||
\section{System API}
|
||||
This section documents api calls that are associated with the system environment.
|
||||
|
||||
\subsection{Get SMTP Configuration}
|
||||
The following will get the current smtp configuration
|
||||
|
||||
\begin{apimethod}
|
||||
{Get SMTP Configuration}
|
||||
{system/getSmtpConfig.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getSmtpConfigResp}}
|
||||
|
||||
\subsection{Update SMTP Configuration}
|
||||
The following will set the smtp configuration. The return value will be the same values that were set.
|
||||
|
||||
Below is the list of the smtp names that can be used:
|
||||
\begin{itemize}
|
||||
\label{list:smtp-keys}
|
||||
\item smtp.enabled
|
||||
\item mail.transport.protocol
|
||||
\item mail.smtp.port
|
||||
\item mail.smtp.host
|
||||
\item mail.smtp.auth
|
||||
\item mail.smtp.starttls.enable
|
||||
\item mail.smtp.starttls.required
|
||||
\item mail.smtp.ssl.trust
|
||||
\item smtp.from.user
|
||||
\item smtp.username
|
||||
\item smtp.password
|
||||
\item mail.debug
|
||||
\end{itemize}
|
||||
|
||||
\begin{apimethod}
|
||||
{Update SMTP Configuration}
|
||||
{system/updateSmtpConfig.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Name of the smtp configuration key}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/response/getSmtpConfigResp}}{\input{api/sample/response/getSmtpConfigResp}}
|
||||
|
||||
\subsection{Get All Environment Variables}
|
||||
|
||||
The following will get all global environment variables on the system.
|
||||
|
||||
\begin{apimethod}
|
||||
{Get All Environment Variables}
|
||||
{system/getAll.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/deleteEnvVarsResp}}
|
||||
|
||||
\subsection{Add Environment Variables}
|
||||
|
||||
The following will add global environment variables to the system.
|
||||
|
||||
Both the request and response values are in json arrays.
|
||||
|
||||
\begin{apimethod}
|
||||
{Add Environment Variables}
|
||||
{system/addEnvVars.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{name}{Unique name of the environment variable}
|
||||
\item \Required{value}{Value of the environment variable}
|
||||
\item \Required{isNew}{\command{true} if its a new environment variable or
|
||||
\command{false} if updating an existing variable}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addEnvVarsReq}}{\input{api/sample/response/addEnvVarsResp}}
|
||||
|
||||
\subsection{Delete Environment Variables}
|
||||
|
||||
The following will delete global environment variables from the system.
|
||||
|
||||
Both the request and response values are in json arrays.
|
||||
|
||||
\begin{apimethod}
|
||||
{Delete Environment Variables}
|
||||
{system/deleteEnvVars.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{id of the environment variable to remove}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteEnvVarsReq}}{\input{api/sample/response/deleteEnvVarsResp}}
|
||||
|
||||
\subsection{Get Email Templates}
|
||||
|
||||
The following will get all the email templates on the system.
|
||||
|
||||
\begin{apimethod}
|
||||
{Get Email Templates}
|
||||
{system/getEmailTemplates.do}
|
||||
{GET}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item None
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/None}}{\input{api/sample/response/getEmailTemplateResp}}
|
||||
|
||||
\subsection{Add Email Template}
|
||||
|
||||
The following will add an email template to the system.
|
||||
|
||||
\begin{apimethod}
|
||||
{Add Email Template}
|
||||
{system/addEmailTemplate.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{emailName}{Unique name of the email template}
|
||||
\item \Required{emailSubject}{Subject of the email.}
|
||||
\item \Required{emailMessage}{Message to be sent to the recipients}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/addEmailTemplateReq}}{\input{api/sample/response/addEmailTemplateResp}}
|
||||
|
||||
\subsection{Delete Email Template}
|
||||
|
||||
The following will delete an email template from the system.
|
||||
|
||||
\begin{apimethod}
|
||||
{Delete Email Template}
|
||||
{system/deleteEmailTemplate.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{id}{Id of the template to delete}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/deleteEmailTemplateReq}}{\input{api/sample/response/addEmailTemplateResp}}
|
||||
|
||||
\subsection{Update Seed}
|
||||
The following will update the aes seed
|
||||
|
||||
\begin{apimethod}
|
||||
{Update Seed}
|
||||
{system/updateSeed.do}
|
||||
{POST}
|
||||
{YES}
|
||||
\begin{itemize}
|
||||
\item \Required{seed}{New seed value}
|
||||
\end{itemize}
|
||||
\end{apimethod}
|
||||
|
||||
\ApiData{\input{api/sample/request/updateSeedReq}}{\input{api/sample/SuccessResp}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
None
|
||||
@@ -0,0 +1,8 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"success":true,
|
||||
"body":true
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,11 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"username": "iparenteau",
|
||||
"name": "Isaac's Creds",
|
||||
"credentialType": "SSH",
|
||||
"passphrase": "foo",
|
||||
"key": "-----BEGIN RSA PRIVATE KEY-----...-----END RSA PRIVATE KEY-----"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,10 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"username": "foo",
|
||||
"password": "bar",
|
||||
"name": "FooBar",
|
||||
"credentialType": "PASSWD",
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,9 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"emailName": "Script Status 2",
|
||||
"emailSubject": "Script Status",
|
||||
"emailMessage": "<p>Script ${script_name} finished with an exit code of ${exit_status}</p>",
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,16 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
"isNew": true
|
||||
},
|
||||
{
|
||||
"name": "MAVEN_HOME",
|
||||
"value": "C:\tools\apache-maven-3.5.2",
|
||||
"isNew": true
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,13 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"name": "Stig Apply",
|
||||
"scm": "https://J65594@bigmac.northgrum.com/bitbucket/scm/saipt/stig-apply.git",
|
||||
"branch": "develop",
|
||||
"directory": "C:\\stigapply",
|
||||
"credentials": {
|
||||
"uid": "a7d6b897-8ec6-483c-9e68-c5a2676dcbf1",
|
||||
}
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,19 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"name": "test",
|
||||
"displayName": "Test",
|
||||
"enabled": true,
|
||||
"permissions": [
|
||||
{
|
||||
"permissionId": 1,
|
||||
"allowed": true
|
||||
},
|
||||
{
|
||||
"permissionId": 2,
|
||||
"allowed": false
|
||||
}
|
||||
]
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,38 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"name": "tomcat running",
|
||||
"command": "netstat",
|
||||
"baseDirectory": "C:\stigapply",
|
||||
"outputDirectory": "",
|
||||
"scriptType": "LOCAL",
|
||||
"parameters": [{
|
||||
"parameter": "-ano",
|
||||
},{
|
||||
"parameter": "|grep",
|
||||
},{
|
||||
"parameter": "8080",
|
||||
}],
|
||||
"schedule": [{
|
||||
"startDatetime": 1524229200673,
|
||||
"endDatetime": 1524834000000,
|
||||
"frequency": "HOURLY",
|
||||
"maxExecutions": null,
|
||||
}],
|
||||
"scriptVariables": [{
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
}],
|
||||
"scriptChain": [{
|
||||
"childScript": 3,
|
||||
"exitStatus": 0
|
||||
}],
|
||||
"scriptEmails": [{
|
||||
"emailName": "Script Status",
|
||||
"recipients": [{
|
||||
"email": "portalAdmin@ngc.com",
|
||||
}]
|
||||
}],
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,42 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"name": "tomcat running",
|
||||
"baseDirectory": "",
|
||||
"outputDirectory": "",
|
||||
"scriptType": "REMOTE",
|
||||
"remote": {
|
||||
"scriptCredentials": {
|
||||
"uid":"e6e99ca6-afee-4de6-ad30-9a8f12429160",
|
||||
},
|
||||
"url": "patchrepo.viprcenter.com",
|
||||
"port": 22
|
||||
},
|
||||
"parameters": [{
|
||||
"parameter": "netstat -ano",
|
||||
},{
|
||||
"parameter": "|grep 8080",
|
||||
}],
|
||||
"schedule": [{
|
||||
"startDatetime": 1524229200673,
|
||||
"endDatetime": 1524834000000,
|
||||
"frequency": "HOURLY",
|
||||
"maxExecutions": null,
|
||||
}],
|
||||
"scriptVariables": [{
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
}],
|
||||
"scriptChain": [{
|
||||
"childScript": 3,
|
||||
"exitStatus": 0
|
||||
}],
|
||||
"scriptEmails": [{
|
||||
"emailName": "Script Status",
|
||||
"recipients": [{
|
||||
"email": "portalAdmin@ngc.com",
|
||||
}]
|
||||
}],
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,39 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"name": "scp script",
|
||||
"baseDirectory": "/opt/tomcat",
|
||||
"outputDirectory": "",
|
||||
"scriptType": "SCP",
|
||||
"scp": {
|
||||
"fromHost": "patchrepo.viprcenter.com",
|
||||
"fromPort": 22,
|
||||
"fromCredentials": {
|
||||
"uid": ...",
|
||||
},
|
||||
"toHost": "LOCAL",
|
||||
"toPort": 0,
|
||||
"toCredentials": {
|
||||
"uid": "...",
|
||||
},
|
||||
"dataRegex": "tomcat_[0-9][0-9]_status.txt"
|
||||
},
|
||||
"schedule": [{
|
||||
"startDatetime": 1524229200673,
|
||||
"endDatetime": 1524834000000,
|
||||
"frequency": "HOURLY",
|
||||
"maxExecutions": null,
|
||||
}],
|
||||
"scriptChain": [{
|
||||
"childScript": 3,
|
||||
"exitStatus": 0
|
||||
}],
|
||||
"scriptEmails": [{
|
||||
"emailName": "Script Status",
|
||||
"recipients": [{
|
||||
"email": "portalAdmin@ngc.com",
|
||||
}]
|
||||
}],
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,13 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"password": "bar",
|
||||
"lastName": "foo",
|
||||
"firstName": "bar",
|
||||
"email": "bar@ngc.com",
|
||||
"role": "USER",
|
||||
"expirationDate": "2028-03-31T19:54:40.550Z",
|
||||
"effectiveDate": "2018-04-03T19:54:39.929Z",
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"uid": "161415ae-07fd-427e-9bf8-3d08a2af7722",
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 4
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,12 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 6,
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 6
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 5
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"name": "TEST"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 4,
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"jobId": "a3bf7cac-bba5-4cd4-bdfa-9fdbcbf08e25",
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"email": "bar@ngc.com",
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,6 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\footnotetext{Send the key name to the server}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
userExpirationDays
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,6 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\footnotetext{Send the job id to the server}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
459db38f-317f-40ad-bcf1-692c0404e7ac
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,8 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"username":"foo",
|
||||
"password":"bar"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,8 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"purgeStartDate": "2018-02-07T05:00:00.000Z",
|
||||
"purgeEndDate": "2018-03-26T04:00:00.000Z"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 4,
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,18 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"name": "test",
|
||||
"enabled": true,
|
||||
"permissions": [
|
||||
{
|
||||
"permissionId": 1,
|
||||
"allowed": true
|
||||
},
|
||||
{
|
||||
"permissionId": 2,
|
||||
"allowed": false
|
||||
}
|
||||
]
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,6 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\footnotetext{Send the seed text to the server}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
This is a seed text
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,14 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 6,
|
||||
"uid": "e6e99ca6-afee-4de6-ad30-9a8f12429160",
|
||||
"name": "Isaac's Creds",
|
||||
"key": null,
|
||||
"passphrase": null,
|
||||
"username": "iparenteau",
|
||||
"credentialType": "SSH"
|
||||
}
|
||||
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,12 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 5,
|
||||
"uid": "252be4f2-d88f-4819-9ddb-e2176364804a",
|
||||
"name": "FooBar",
|
||||
"username": "Foo",
|
||||
"password": null,
|
||||
"credentialType": "PASSWD"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,12 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 4,
|
||||
"emailName": "Script Status 2",
|
||||
"emailSubject": "Script Status",
|
||||
"emailMessage": "<p>Script ${script_name} finished with an exit code of ${exit_status}</p>",
|
||||
"createdBy": 1,
|
||||
"dateCreated": 1524165482009
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,24 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 6,
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
"createdBy": 1,
|
||||
"lastUpdated": 1524158738000,
|
||||
"dateCreated": 1524158738000,
|
||||
"isNew": false
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
"name": "MAVEN_HOME",
|
||||
"value": "C:\tools\apache-maven-3.5.2",
|
||||
"createdBy": 1,
|
||||
"lastUpdated": 1524158738000,
|
||||
"dateCreated": 1524158738000,
|
||||
"isNew": false
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,21 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 5,
|
||||
"name": "Stig Apply",
|
||||
"scm": "https://J65594@bigmac.northgrum.com/bitbucket/scm/saipt/stig-apply.git",
|
||||
"branch": "develop",
|
||||
"directory": "C:\\stigapply",
|
||||
"credentials": {
|
||||
"id": 3,
|
||||
"uid": "a7d6b897-8ec6-483c-9e68-c5a2676dcbf1",
|
||||
"name": "Bit Bucket",
|
||||
"username": "J65594",
|
||||
"credentialType": "PASSWD"
|
||||
},
|
||||
"lastUpdated": 1523988019143,
|
||||
"createDate": 1523988019143,
|
||||
"createdBy": "Portal Admin"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,30 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 3,
|
||||
"name": "TEST",
|
||||
"displayName": "Test",
|
||||
"enabled": true,
|
||||
"permissions": [
|
||||
{
|
||||
"id": 245,
|
||||
"name": "VIEW_SCRIPTS_TAB",
|
||||
"displayName": "View Repository Bank Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 1,
|
||||
"permissionGroupId": 3,
|
||||
"allowed": true
|
||||
},
|
||||
{
|
||||
"id": 246,
|
||||
"name": "VIEW_USER_TAB",
|
||||
"displayName": "View User Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 2,
|
||||
"permissionGroupId": 3,
|
||||
"allowed": false
|
||||
}
|
||||
]
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,71 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 4,
|
||||
"name": "tomcat running",
|
||||
"command": "netstat",
|
||||
"scriptType": "LOCAL",
|
||||
"baseDirectory": "C:\stigapply",
|
||||
"outputDirectory": "",
|
||||
"parameters": [{
|
||||
"id": 1,
|
||||
"parameter": "-ano",
|
||||
"script": 4
|
||||
},{
|
||||
"id": 2,
|
||||
"parameter": "|grep",
|
||||
"script": 4
|
||||
},{
|
||||
"id": 3,
|
||||
"parameter": "8080",
|
||||
"script": 4
|
||||
}],
|
||||
"schedule": [{
|
||||
"id": 5,
|
||||
"jobId": "...",
|
||||
"startDatetime": 1524229201000,
|
||||
"endDatetime": 1524834000000,
|
||||
"frequency": "HOURLY",
|
||||
"maxExecutions": null,
|
||||
"currentExecutionCount": null,
|
||||
"executionStatus": null,
|
||||
"lastRun": 0,
|
||||
"script": 4
|
||||
}],
|
||||
"scriptVariables": [{
|
||||
"id": 1,
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
"createdBy": 1,
|
||||
"lastUpdated": 1524226391000,
|
||||
"dateCreated": 1524226391000,
|
||||
"isNew": null,
|
||||
"script": 4
|
||||
}],
|
||||
"scriptChain": [{
|
||||
"id": 1,
|
||||
"parentScript": 4,
|
||||
"childScript": 3,
|
||||
"executeAfterMin": null,
|
||||
"exitStatus": 0
|
||||
}],
|
||||
"scriptEmails": [{
|
||||
"id": 1,
|
||||
"emailName": "Script Status",
|
||||
"emailSubject": "Script Status",
|
||||
"emailMessage": "...",
|
||||
"scriptId": 4,
|
||||
"recipients": [{
|
||||
"id": 1,
|
||||
"firstName": "Portal",
|
||||
"lastName": "Admin",
|
||||
"role": "ADMIN",
|
||||
"email": "portalAdmin@ngc.com",
|
||||
"expirationDate": 2.534022324e+14,
|
||||
"effectiveDate": 1519275600000,
|
||||
"enabled": true
|
||||
}]
|
||||
}],
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,74 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 4,
|
||||
"name": "tomcat running",
|
||||
"command": "REMOTE",
|
||||
"scriptType": "REMOTE",
|
||||
"baseDirectory": "",
|
||||
"outputDirectory": "",
|
||||
"parameters": [{
|
||||
"id": 4,
|
||||
"parameter": "netstat -ano",
|
||||
"script": 6
|
||||
},{
|
||||
"id": 5,
|
||||
"parameter": "|grep 8080",
|
||||
"script": 6
|
||||
}],"schedule": [{
|
||||
"id": 5,
|
||||
"jobId": "...",
|
||||
"startDatetime": 1524229201000,
|
||||
"endDatetime": 1524834000000,
|
||||
"frequency": "HOURLY",
|
||||
"maxExecutions": null,
|
||||
"currentExecutionCount": null,
|
||||
"executionStatus": null,
|
||||
"lastRun": 0,
|
||||
"script": 4
|
||||
}],"scriptVariables": [{
|
||||
"id": 1,
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
"createdBy": 1,
|
||||
"lastUpdated": 1524226391000,
|
||||
"dateCreated": 1524226391000,
|
||||
"isNew": null,
|
||||
"script": 4
|
||||
}],"scriptChain": [{
|
||||
"id": 1,
|
||||
"parentScript": 4,
|
||||
"childScript": 3,
|
||||
"executeAfterMin": null,
|
||||
"exitStatus": 0
|
||||
}],"scriptEmails": [{
|
||||
"id": 1,
|
||||
"emailName": "Script Status",
|
||||
"emailSubject": "Script Status",
|
||||
"emailMessage": "...",
|
||||
"scriptId": 4,
|
||||
"recipients": [{
|
||||
"id": 1,
|
||||
"firstName": "Portal",
|
||||
"lastName": "Admin",
|
||||
"role": "ADMIN",
|
||||
"email": "portalAdmin@ngc.com",
|
||||
"expirationDate": 2.534022324e+14,
|
||||
"effectiveDate": 1519275600000,
|
||||
"enabled": true
|
||||
}]
|
||||
}],"remote": {
|
||||
"scriptId": 6,
|
||||
"scriptCredentials": {
|
||||
"id": 6,
|
||||
"uid": "e6e99ca6-afee-4de6-ad30-9a8f12429160",
|
||||
"name": "Isaac's Creds",
|
||||
"username": "iparenteau",
|
||||
"credentialType": "SSH"
|
||||
},
|
||||
"url": "patchrepo.viprcenter.com",
|
||||
"port": 22
|
||||
},
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,51 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 7,
|
||||
"name": "scp script",
|
||||
"command": "SCP",
|
||||
"scriptType": "SCP",
|
||||
"baseDirectory": "/opt/tomcat",
|
||||
"outputDirectory": "",
|
||||
"scp": {
|
||||
"id": 1,
|
||||
"scriptId": 7,
|
||||
"fromHost": "patchrepo.viprcenter.com",
|
||||
"fromPort": 22,
|
||||
"fromCredentials": {
|
||||
"id": 3,
|
||||
"uid": "a7d6b897-8ec6-483c-9e68-c5a2676dcbf1",
|
||||
"name": "Bit Bucket",
|
||||
"username": "J65594",
|
||||
"credentialType": "PASSWD"
|
||||
},
|
||||
"toHost": "LOCAL",
|
||||
"toPort": 0,
|
||||
"toCredentials": {
|
||||
"id": 3,
|
||||
"uid": "a7d6b897-8ec6-483c-9e68-c5a2676dcbf1",
|
||||
"name": "Bit Bucket",
|
||||
"username": "J65594",
|
||||
"credentialType": "PASSWD"
|
||||
},
|
||||
"dataRegex": "tomcat_[0-9][0-9]_status.txt"
|
||||
},
|
||||
"schedule": [{
|
||||
"startDatetime": 1524229200673,
|
||||
"endDatetime": 1524834000000,
|
||||
"frequency": "HOURLY",
|
||||
"maxExecutions": null,
|
||||
}],
|
||||
"scriptChain": [{
|
||||
"childScript": 3,
|
||||
"exitStatus": 0
|
||||
}],
|
||||
"scriptEmails": [{
|
||||
"emailName": "Script Status",
|
||||
"recipients": [{
|
||||
"email": "portalAdmin@ngc.com",
|
||||
}]
|
||||
}],
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,17 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 3,
|
||||
"auId": 3,
|
||||
"firstName": "bar",
|
||||
"lastName": "foo",
|
||||
"role": "USER",
|
||||
"username": "bar@ngc.com",
|
||||
"password": null,
|
||||
"email": "bar@ngc.com",
|
||||
"expirationDate": 1838145280550,
|
||||
"effectiveDate": 1522785279929,
|
||||
"enabled": true
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,11 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 8,
|
||||
"uid": "161415ae-07fd-427e-9bf8-3d08a2af7722",
|
||||
"name": "FooBar",
|
||||
"username": "foo",
|
||||
"credentialType": "PASSWD"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,24 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 6,
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
"createdBy": 1,
|
||||
"lastUpdated": 1524158738000,
|
||||
"dateCreated": 1524158738000,
|
||||
"isNew": false
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
"name": "MAVEN_HOME",
|
||||
"value": "C:\tools\apache-maven-3.5.2",
|
||||
"createdBy": 1,
|
||||
"lastUpdated": 1524158738000,
|
||||
"dateCreated": 1524158738000,
|
||||
"isNew": false
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,30 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 3,
|
||||
"name": "TEST",
|
||||
"displayName": "Test",
|
||||
"enabled": false,
|
||||
"permissions": [
|
||||
{
|
||||
"id": 245,
|
||||
"name": "VIEW_SCRIPTS_TAB",
|
||||
"displayName": "View Repository Bank Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 1,
|
||||
"permissionGroupId": 3,
|
||||
"allowed": true
|
||||
},
|
||||
{
|
||||
"id": 246,
|
||||
"name": "VIEW_USER_TAB",
|
||||
"displayName": "View User Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 2,
|
||||
"permissionGroupId": 3,
|
||||
"allowed": false
|
||||
}
|
||||
]
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,16 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 6,
|
||||
"jobId": "a3bf7cac-bba5-4cd4-bdfa-9fdbcbf08e25",
|
||||
"startDatetime": 1524229332000,
|
||||
"endDatetime": null,
|
||||
"frequency": "NOW",
|
||||
"maxExecutions": 1,
|
||||
"currentExecutionCount": 1,
|
||||
"executionStatus": 1,
|
||||
"lastRun": 1524229357000,
|
||||
"script": 4
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,20 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 3,
|
||||
"uid": "a7d6b897-8ec6-483c-9e68-c5a2676dcbf1",
|
||||
"name": "Bit Bucket",
|
||||
"username": "J65594",
|
||||
"credentialType": "PASSWD"
|
||||
},
|
||||
{
|
||||
"id": 6,
|
||||
"uid": "e6e99ca6-afee-4de6-ad30-9a8f12429160",
|
||||
"name": "Isaac's Creds",
|
||||
"username": "iparenteau",
|
||||
"credentialType": "SSH"
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,33 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 45,
|
||||
"loggedBy": "Repo Admin",
|
||||
"eventName": "USER DELETED",
|
||||
"event": "Deleted bar foo",
|
||||
"severity": "INFO",
|
||||
"ipAddress": "127.0.0.1",
|
||||
"timestamp": 1522787487000
|
||||
},
|
||||
{
|
||||
"id": 44,
|
||||
"loggedBy": "Repo Admin",
|
||||
"eventName": "LOGIN",
|
||||
"event": "Logged in",
|
||||
"severity": "INFO",
|
||||
"ipAddress": "127.0.0.1",
|
||||
"timestamp": 1522787466000
|
||||
},
|
||||
{
|
||||
"id": 43,
|
||||
"loggedBy": "Repo Admin",
|
||||
"eventName": "EXCEPTION",
|
||||
"event": "Something went wrong. Please see logs for details",
|
||||
"severity": "ERROR",
|
||||
"ipAddress": "127.0.0.1",
|
||||
"timestamp": 1522787194000
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,20 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "ADMIN",
|
||||
"displayName": "Administrator",
|
||||
"enabled": true,
|
||||
"permissions": []
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "USER",
|
||||
"displayName": "User",
|
||||
"enabled": true,
|
||||
"permissions": []
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,23 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 5,
|
||||
"name": "Stig Apply",
|
||||
"scm": "https://J65594@bigmac.northgrum.com/bitbucket/scm/saipt/stig-apply.git",
|
||||
"branch": "develop",
|
||||
"directory": "C:\\stigapply",
|
||||
"credentials": {
|
||||
"id": 3,
|
||||
"uid": "a7d6b897-8ec6-483c-9e68-c5a2676dcbf1",
|
||||
"name": "Bit Bucket",
|
||||
"username": "J65594",
|
||||
"credentialType": "PASSWD"
|
||||
},
|
||||
"lastUpdated": 1523988019143,
|
||||
"createDate": 1523988019143,
|
||||
"createdBy": "Portal Admin"
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,71 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[{
|
||||
"id": 4,
|
||||
"name": "tomcat running",
|
||||
"command": "netstat",
|
||||
"scriptType": "LOCAL",
|
||||
"baseDirectory": "C:\stigapply",
|
||||
"outputDirectory": "",
|
||||
"parameters": [{
|
||||
"id": 1,
|
||||
"parameter": "-ano",
|
||||
"script": 4
|
||||
},{
|
||||
"id": 2,
|
||||
"parameter": "|grep",
|
||||
"script": 4
|
||||
},{
|
||||
"id": 3,
|
||||
"parameter": "8080",
|
||||
"script": 4
|
||||
}],
|
||||
"schedule": [{
|
||||
"id": 5,
|
||||
"jobId": "...",
|
||||
"startDatetime": 1524229201000,
|
||||
"endDatetime": 1524834000000,
|
||||
"frequency": "HOURLY",
|
||||
"maxExecutions": null,
|
||||
"currentExecutionCount": null,
|
||||
"executionStatus": null,
|
||||
"lastRun": 0,
|
||||
"script": 4
|
||||
}],
|
||||
"scriptVariables": [{
|
||||
"id": 1,
|
||||
"name": "JAVA_HOME",
|
||||
"value": "C:\Program Files\Java\jdk1.8.0_152",
|
||||
"createdBy": 1,
|
||||
"lastUpdated": 1524226391000,
|
||||
"dateCreated": 1524226391000,
|
||||
"isNew": null,
|
||||
"script": 4
|
||||
}],
|
||||
"scriptChain": [{
|
||||
"id": 1,
|
||||
"parentScript": 4,
|
||||
"childScript": 3,
|
||||
"executeAfterMin": null,
|
||||
"exitStatus": 0
|
||||
}],
|
||||
"scriptEmails": [{
|
||||
"id": 1,
|
||||
"emailName": "Script Status",
|
||||
"emailSubject": "Script Status",
|
||||
"emailMessage": "...",
|
||||
"scriptId": 4,
|
||||
"recipients": [{
|
||||
"id": 1,
|
||||
"firstName": "Portal",
|
||||
"lastName": "Admin",
|
||||
"role": "ADMIN",
|
||||
"email": "portalAdmin@ngc.com",
|
||||
"expirationDate": 2.534022324e+14,
|
||||
"effectiveDate": 1519275600000,
|
||||
"enabled": true
|
||||
}]
|
||||
}],
|
||||
}]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,32 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"auId": 1,
|
||||
"firstName": "Repo",
|
||||
"lastName": "Admin",
|
||||
"role": "ADMIN",
|
||||
"username": "portalAdmin@ngc.com",
|
||||
"password": null,
|
||||
"email": "portalAdmin@ngc.com",
|
||||
"expirationDate": 2.534022324e+14,
|
||||
"effectiveDate": 1517979600000,
|
||||
"enabled": true
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"auId": 2,
|
||||
"firstName": "foo",
|
||||
"lastName": "bar",
|
||||
"role": "USER",
|
||||
"username": "foo@ngc.com",
|
||||
"password": null,
|
||||
"email": "foo@ngc.com",
|
||||
"expirationDate": 1838088000000,
|
||||
"effectiveDate": 1522728000000,
|
||||
"enabled": true
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,16 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"logLevel": "INFO",
|
||||
"userExpirationDays": "3650",
|
||||
"dbRootPassword": "Em46JDIzVOWBgGFqxDrqnw==",
|
||||
"dbHost": "localhost",
|
||||
"dbPort": "3306",
|
||||
"dbRootUser": "root",
|
||||
"dbUsername": "portalAdmin",
|
||||
"filepath": "C:\\tempStorage",
|
||||
"dbPassword": "CWg48+h4q7iK4ICGaDhRd10EMQfFgthm3FjhkLd6gis="
|
||||
"aesSeedFile": "C:/development/apache-tomcat-8.5.24/conf/portal.tomcat"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,7 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"userExpirationDays": 3650
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,16 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "SSH",
|
||||
"value": "SSH Key"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "PASSWD",
|
||||
"value": "Username/Password"
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,16 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"emailName": "Script Status",
|
||||
"emailSubject": "Script Status",
|
||||
"emailMessage": "<p>Script ${script_name} finished with exit code of ${exit_status}</p>\n
|
||||
<p><strong>Results:</strong></p>\n<p>${script_results}</p>\n<p>Thank you,</p>\n
|
||||
<p>postmaster@viprcenter.com</p>",
|
||||
"createdBy": null,
|
||||
"dateCreated": null
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,22 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"logger": "AbstractObjectMessageHandler",
|
||||
"level": "INFO"
|
||||
},
|
||||
{
|
||||
"logger": "AccountController",
|
||||
"level": "ERROR"
|
||||
},
|
||||
{
|
||||
"logger": "ApplicationLogController",
|
||||
"level": "INFO"
|
||||
},
|
||||
{
|
||||
"logger": "ApplicationLogService",
|
||||
"level": "INFO"
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,56 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "TABS",
|
||||
"displayName": "Tabs",
|
||||
"permissions": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "VIEW_SCRIPTS_TAB",
|
||||
"displayName": "View Repository Bank Tab",
|
||||
"permissionCategory": "TABS"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "VIEW_USER_TAB",
|
||||
"displayName": "View User Tab",
|
||||
"permissionCategory": "TABS"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "VIEW_LOG_TAB",
|
||||
"displayName": "View System Log Tab",
|
||||
"permissionCategory": "TABS"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "VIEW_PERMISSION_TAB",
|
||||
"displayName": "View Permission Tab",
|
||||
"permissionCategory": "TABS"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "PERMISSION_TAB",
|
||||
"displayName": "Permissions Tab",
|
||||
"permissions": [
|
||||
{
|
||||
"id": 22,
|
||||
"name": "ADD_PERMS",
|
||||
"displayName": "Add/Edit Permissions",
|
||||
"permissionCategory": "PERMISSION_TAB"
|
||||
},
|
||||
{
|
||||
"id": 23,
|
||||
"name": "DELETE_PERMS",
|
||||
"displayName": "Delete Permissions",
|
||||
"permissionCategory": "PERMISSION_TAB"
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,60 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "ADMIN",
|
||||
"displayName": "Administrator",
|
||||
"enabled": true,
|
||||
"permissions": [
|
||||
{
|
||||
"type": null,
|
||||
"id": 181,
|
||||
"name": "VIEW_SCRIPTS_TAB",
|
||||
"displayName": "View Scripts Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 1,
|
||||
"permissionGroupId": 1,
|
||||
"allowed": true
|
||||
},
|
||||
{
|
||||
"type": null,
|
||||
"id": 182,
|
||||
"name": "VIEW_USER_TAB",
|
||||
"displayName": "View User Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 2,
|
||||
"permissionGroupId": 1,
|
||||
"allowed": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "USER",
|
||||
"displayName": "User",
|
||||
"enabled": true,
|
||||
"permissions": [
|
||||
{
|
||||
"id": 233,
|
||||
"name": "VIEW_SCRIPTS_TAB",
|
||||
"displayName": "View Repository Bank Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 1,
|
||||
"permissionGroupId": 2,
|
||||
"allowed": true
|
||||
},
|
||||
{
|
||||
"id": 234,
|
||||
"name": "VIEW_USER_TAB",
|
||||
"displayName": "View User Tab",
|
||||
"permissionCategory": "TABS",
|
||||
"permissionId": 2,
|
||||
"permissionGroupId": 2,
|
||||
"allowed": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,46 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "HOURLY",
|
||||
"value": "Hourly"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "DAILY",
|
||||
"value": "Daily"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "WEEKLY",
|
||||
"value": "Weekly"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "MONTHLY",
|
||||
"value": "Monthly"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"name": "YEARLY",
|
||||
"value": "Yearly"
|
||||
},
|
||||
{
|
||||
"id": 6,
|
||||
"name": "NOW",
|
||||
"value": "Now"
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
"name": "SPECIFIC",
|
||||
"value": "Specific"
|
||||
},
|
||||
{
|
||||
"id": 8,
|
||||
"name": "TRIGGERED",
|
||||
"value": "Triggered"
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,26 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 31,
|
||||
"exitStatus": 0,
|
||||
"results": "...",
|
||||
"startTime": 1524243606000,
|
||||
"endTime": 1524243606000,
|
||||
"resourceFiles": [
|
||||
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 30,
|
||||
"exitStatus": 0,
|
||||
"results": "..",
|
||||
"startTime": 1524240727000,
|
||||
"endTime": 1524240727000,
|
||||
"resourceFiles": [
|
||||
|
||||
]
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,21 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "LOCAL",
|
||||
"value": "Local Execution"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "REMOTE",
|
||||
"value": "Remote Execution"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "SCP",
|
||||
"value": "Secure Copy"
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,31 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"name": "smtp.enabled",
|
||||
"value": "false"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "mail.transport.protocol",
|
||||
"value": "smtp"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "mail.smtp.host",
|
||||
"value": ""
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "mail.smtp.port",
|
||||
"value": "0"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"name": "mail.debug",
|
||||
"value": "false"
|
||||
}
|
||||
]
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,8 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"success":false,
|
||||
"body":null
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,32 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"id": 1,
|
||||
"auId": 1,
|
||||
"firstName": "foo",
|
||||
"lastName": "bar",
|
||||
"role": "USER",
|
||||
"username": "foo@ngc.com",
|
||||
"email": "foo@ngc.com",
|
||||
"expirationDate": 2.534022324e+14,
|
||||
"effectiveDate": 1517979600000,
|
||||
"enabled": true,
|
||||
"isNew": false,
|
||||
"authorities": [
|
||||
"VIEW_REPO_TAB",
|
||||
"VIEW_USER_TAB",
|
||||
"VIEW_LOG_TAB",
|
||||
"VIEW_PERMISSION_TAB",
|
||||
"VIEW_CONFIG",
|
||||
"VIEW_HASH_TYPES",
|
||||
"VIEW_FILE_INFO",
|
||||
"VIEW_LOG_LEVELS",
|
||||
],
|
||||
"stompTopics": [
|
||||
"/topic/account|system",
|
||||
"/topic/account|1"
|
||||
],
|
||||
"page": "dashboard"
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
@@ -0,0 +1,9 @@
|
||||
\begin{minipage}[t]{0.45\textwidth}
|
||||
\footnotetext{The return value in body is the number of logs that were purged}
|
||||
\begin{lstlisting}[language=JSON]
|
||||
{
|
||||
"success":true,
|
||||
"body":13
|
||||
}
|
||||
\end{lstlisting}
|
||||
\end{minipage}
|
||||
Reference in new issue
Block a user