Create Single In-House Rule

SCA API 2.0

Create Single In-House Rule

Request

Creates a single In-House rule to match libraries by name or maven coordinates (artifact id, group id) and designate these libraries as known, trusted entities

Security

bearer-key

Path

orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

Bodyapplication/jsonrequired

typestring(InHouse Rule Regex Type)required

Enum:"NAME""LIBRARY_COORDINATES""ARTIFACT_ID"

Example:"NAME"

regexstring(InHouse Regex Rule)required

Example:"*aa*"

descriptionstring(InHouse Description)

Example:"description for inHouse rule"

emptyboolean

POST

/api/v2.0/orgs/{orgToken}/settings/inHouse

{
  "type": "NAME",
  "regex": "*aa*",
  "description": "description for inHouse rule",
  "empty": true
}

Responses

Bodyapplication/json

additionalDataobject(Provides warning messages for notifying about conditions related to the )

warningMessage: Serves as an alert to inform you about the status of the rule being updated. The warning message will provide information about whether the rule already exists or if some of the rules are already present

Example:

{
  "warningMessage": "item already exists"
}

supportTokenstring(Support Token)

Example:"1171c60d"

retValobject(InHouseRuleDTO)

Response

{
  "additionalData": {
    "warningMessage": "item already exists"
  },
  "supportToken": "1171c60d",
  "retVal": {
    "uuid": "string",
    "type": "NAME",
    "regex": ".*a*",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "empty": true
  }
}