Rapid Models Registration and Login Module API Definition
This API definition facilitates auditing static analysis alerts using classifiers, optional adaptive heuristics, and alert prioritization. The API enables jump-starting labeled datasets using test suites. It is intended to enable a wide range of users (with widely varying datasets, static analysis tools, machine learning expertise, and amount of labeled data) to benefit from using classifiers and sophisticated prioritization to automatically triage static analysis alerts.
Version: 0.0.3
BasePath:
Software Engineering Institute - Copyright (c) 2007-2019 Carnegie Mellon University. All Rights Reserved.
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
get /authenticate/{server_name}
Authenticate the access token for the servers (authenticateServerAccess)
Path parameters
server_name (required)
Path Parameter — Name of the server to verify access to, expected values [statistics, datahub, prioritization]
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
request_token
400
Invalid Request, Token Invalid
default
Unexpected Error
error
Provides Server Status (getStatus)
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Server Is Running
request_token
400
Database Connection Lost
default
Unexpected Error
error
Up
get /servers/{server_name}
Get access token to use other servers (getServerAccess)
Path parameters
server_name (required)
Path Parameter — Name of the server to grant access to, expected values [statistics, datahub, prioritization]
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"x_access_token" : "x_access_token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
access_token
400
Invalid Request
405
Server Access Unavailable
default
Unexpected Error
error
Login page; Authenticate to the SCAIFE system (loginUser)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Login credentials for the user.
Return type
Example data
Content-Type: application/json
{
"x_access_token" : "x_access_token"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
access_token
400
Invalid Request
405
Login Unavailable
default
Unexpected Error
error
Logout of the SCAIFE system (logoutUser)
Consumes
This API call consumes the following media types via the request header:
Request headers
Return type
Example data
Content-Type: application/json
{
"message" : "message",
"request_id" : "request_id"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK, User Successfully Logged Out
request_token
400
Invalid Request
405
Logout Unavailable
default
Unexpected Error
error
Registration page; Create new users in the SCAIFE system (registerUsers)
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — User information
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
User Created
400
Invalid Request
405
Registration Unavailable
default
Unexpected Error
error
[ Jump to Methods ]
Table of Contents
access_token - error - login_credentials - request_token - user_information -
x_access_token (optional)
username (optional)
password (optional)
request_id (optional)
message (optional)
first_name (optional)
last_name (optional)
organization_name
username
password