Security Plane API (0.0.1-alpha.0.0)

Download OpenAPI specification:

Security Plane API

security

Operations related to security

DataEgress

/api/DataEgress/AddNewDataEgress

Authorizations:
Bearer
Request Body schema:
id
integer <int32>
submissionId
string or null
status
integer <int32> (EgressStatus)
Enum: 0 1 2 3
outputBucket
string or null
completed
string or null <date-time>
reviewer
string or null
Array of objects or null (EgressFile)
tesId
string or null
name
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "submissionId": "string",
  • "status": 0,
  • "outputBucket": "string",
  • "completed": "2019-08-24T14:15:22Z",
  • "reviewer": "string",
  • "files": [
    ],
  • "tesId": "string",
  • "name": "string"
}

Response samples

Content type
No sample

/api/DataEgress/GetAllEgresses

Authorizations:
Bearer
query Parameters
unprocessedonly
boolean

Responses

Response samples

Content type
No sample

/api/DataEgress/GetEgress

Authorizations:
Bearer
query Parameters
id
integer <int32>

Responses

Response samples

Content type
No sample

/api/DataEgress/GetEgressFile/{id}

Authorizations:
Bearer
path Parameters
id
required
integer <int32>

Responses

Response samples

Content type
No sample

/api/DataEgress/CompleteEgress

Authorizations:
Bearer
Request Body schema:
id
integer <int32>
submissionId
string or null
status
integer <int32> (EgressStatus)
Enum: 0 1 2 3
outputBucket
string or null
completed
string or null <date-time>
reviewer
string or null
Array of objects or null (EgressFile)
tesId
string or null
name
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "submissionId": "string",
  • "status": 0,
  • "outputBucket": "string",
  • "completed": "2019-08-24T14:15:22Z",
  • "reviewer": "string",
  • "files": [
    ],
  • "tesId": "string",
  • "name": "string"
}

Response samples

Content type
No sample

/api/DataEgress/PartialEgress

Authorizations:
Bearer
Request Body schema:
id
integer <int32>
submissionId
string or null
status
integer <int32> (EgressStatus)
Enum: 0 1 2 3
outputBucket
string or null
completed
string or null <date-time>
reviewer
string or null
Array of objects or null (EgressFile)
tesId
string or null
name
string or null

Responses

Request samples

Content type
{
  • "id": 0,
  • "submissionId": "string",
  • "status": 0,
  • "outputBucket": "string",
  • "completed": "2019-08-24T14:15:22Z",
  • "reviewer": "string",
  • "files": [
    ],
  • "tesId": "string",
  • "name": "string"
}

Response samples

Content type
No sample

/api/DataEgress/UpdateFileData

Authorizations:
Bearer
query Parameters
fileId
integer <int32>
status
integer <int32> (FileStatus)
Enum: 0 1 2

Responses

Response samples

Content type
No sample

/api/DataEgress/DownloadFile

Authorizations:
Bearer
query Parameters
id
integer <int32>

Responses

TreCredentials

/api/TreCredentials/CheckCredentialsAreValid

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/TreCredentials/EgressCheckCredentialsAreValid

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/TreCredentials/EgressUpdateCredentials

Authorizations:
Bearer
Request Body schema:
error
boolean
errorMessage
string or null
id
integer <int32>
userName
required
string non-empty
passwordEnc
required
string non-empty
confirmPassword
string or null
credentialType
integer <int32> (CredentialType)
Enum: 0 1 2
valid
boolean

Responses

Request samples

Content type
{
  • "error": true,
  • "errorMessage": "string",
  • "id": 0,
  • "userName": "string",
  • "passwordEnc": "string",
  • "confirmPassword": "string",
  • "credentialType": 0,
  • "valid": true
}

Response samples

Content type
No sample

/api/TreCredentials/UpdateCredentials

Authorizations:
Bearer
Request Body schema:
error
boolean
errorMessage
string or null
id
integer <int32>
userName
required
string non-empty
passwordEnc
required
string non-empty
confirmPassword
string or null
credentialType
integer <int32> (CredentialType)
Enum: 0 1 2
valid
boolean

Responses

Request samples

Content type
{
  • "error": true,
  • "errorMessage": "string",
  • "id": 0,
  • "userName": "string",
  • "passwordEnc": "string",
  • "confirmPassword": "string",
  • "credentialType": 0,
  • "valid": true
}

Response samples

Content type
No sample

DataEgressCredentials

/api/TreCredentials/UpdateCredentials

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

/api/DataEgressCredentials/UpdateCredentials

Authorizations:
Bearer
Request Body schema:
error
boolean
errorMessage
string or null
id
integer <int32>
userName
required
string non-empty
passwordEnc
required
string non-empty
confirmPassword
string or null
credentialType
integer <int32> (CredentialType)
Enum: 0 1 2
valid
boolean

Responses

Request samples

Content type
{
  • "error": true,
  • "errorMessage": "string",
  • "id": 0,
  • "userName": "string",
  • "passwordEnc": "string",
  • "confirmPassword": "string",
  • "credentialType": 0,
  • "valid": true
}

Response samples

Content type
No sample