Update Finding Transformation Rule

Update an existing finding transformation rule’s match criteria or transforms.

POST /api/v1/findings/transformation-rules/{transformation_rule_id}/update

UpdateFindingTransformationRule

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.FindingTransformationRule.UpdateFindingTransformationRule(ctx, operations.C1APIFindingV1FindingTransformationRuleServiceUpdateFindingTransformationRuleRequest{
        TransformationRuleID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateFindingTransformationRuleResponse != nil {
        // handle response
    }
}

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/findings/transformation-rules/{transformation_rule_id}/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "transformationRule": {
    "appId": "<string>",
    "condition": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "displayName": "<string>",
    "enabled": true,
    "evaluationOrder": 123,
    "id": "<string>",
    "templateId": "<string>",
    "transforms": [
      {
        "removeTags": {
          "keys": [
            "<string>"
          ]
        },
        "setSeverity": {},
        "setTags": {
          "tags": {}
        }
      }
    ],
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/findings/transformation-rules/{transformation_rule_id}/update"

payload = { "transformationRule": {
        "appId": "<string>",
        "condition": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "displayName": "<string>",
        "enabled": True,
        "evaluationOrder": 123,
        "id": "<string>",
        "templateId": "<string>",
        "transforms": [
            {
                "removeTags": { "keys": ["<string>"] },
                "setSeverity": {},
                "setTags": { "tags": {} }
            }
        ],
        "updatedAt": "2023-11-07T05:31:56Z"
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    transformationRule: {
      appId: '<string>',
      condition: '<string>',
      createdAt: '2023-11-07T05:31:56Z',
      description: '<string>',
      displayName: '<string>',
      enabled: true,
      evaluationOrder: 123,
      id: '<string>',
      templateId: '<string>',
      transforms: [{removeTags: {keys: ['<string>']}, setSeverity: {}, setTags: {tags: {}}}],
      updatedAt: '2023-11-07T05:31:56Z'
    }
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/findings/transformation-rules/{transformation_rule_id}/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/findings/transformation-rules/{transformation_rule_id}/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'transformationRule' => [
        'appId' => '<string>',
        'condition' => '<string>',
        'createdAt' => '2023-11-07T05:31:56Z',
        'description' => '<string>',
        'displayName' => '<string>',
        'enabled' => true,
        'evaluationOrder' => 123,
        'id' => '<string>',
        'templateId' => '<string>',
        'transforms' => [
                [
                                'removeTags' => [
                                                                'keys' => [
                                                                                                                                '<string>'
                                                                ]
                                ],
                                'setSeverity' => [
                                                                
                                ],
                                'setTags' => [
                                                                'tags' => [
                                                                                                                                
                                                                ]
                                ]
                ]
        ],
        'updatedAt' => '2023-11-07T05:31:56Z'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/findings/transformation-rules/{transformation_rule_id}/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"transformationRule\": {\n    \"appId\": \"<string>\",\n    \"condition\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"enabled\": true,\n    \"evaluationOrder\": 123,\n    \"id\": \"<string>\",\n    \"templateId\": \"<string>\",\n    \"transforms\": [\n      {\n        \"removeTags\": {\n          \"keys\": [\n            \"<string>\"\n          ]\n        },\n        \"setSeverity\": {},\n        \"setTags\": {\n          \"tags\": {}\n        }\n      }\n    ],\n    \"updatedAt\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/findings/transformation-rules/{transformation_rule_id}/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"transformationRule\": {\n    \"appId\": \"<string>\",\n    \"condition\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"description\": \"<string>\",\n    \"displayName\": \"<string>\",\n    \"enabled\": true,\n    \"evaluationOrder\": 123,\n    \"id\": \"<string>\",\n    \"templateId\": \"<string>\",\n    \"transforms\": [\n      {\n        \"removeTags\": {\n          \"keys\": [\n            \"<string>\"\n          ]\n        },\n        \"setSeverity\": {},\n        \"setTags\": {\n          \"tags\": {}\n        }\n      }\n    ],\n    \"updatedAt\": \"2023-11-07T05:31:56Z\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "transformationRule": {
    "appId": "<string>",
    "condition": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "displayName": "<string>",
    "enabled": true,
    "evaluationOrder": 123,
    "id": "<string>",
    "templateId": "<string>",
    "transforms": [
      {
        "removeTags": {
          "keys": [
            "<string>"
          ]
        },
        "setSeverity": {},
        "setTags": {
          "tags": {}
        }
      }
    ],
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

transformation_rule_id · string · required

The id field.

Body

application/json

The UpdateFindingTransformationRuleRequest message.

transformationRule · Finding Transformation Rule · object | null

FindingTransformationRule transforms a finding at processing time, before routing runs. Rules fall through: every matching rule applies its transforms in ascending evaluation_order; the last rule to write a given field wins.

Show child attributes

Response

200 - application/json

Successful response

The UpdateFindingTransformationRuleResponse message.

transformationRule · Finding Transformation Rule · object | null

FindingTransformationRule transforms a finding at processing time, before routing runs. Rules fall through: every matching rule applies its transforms in ascending evaluation_order; the last rule to write a given field wins.

Show child attributes