xref: /aosp_15_r20/external/googleapis/google/cloud/securitycenter/v1/external_system.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.securitycenter.v1;
18
19import "google/api/resource.proto";
20import "google/protobuf/timestamp.proto";
21
22option csharp_namespace = "Google.Cloud.SecurityCenter.V1";
23option go_package = "cloud.google.com/go/securitycenter/apiv1/securitycenterpb;securitycenterpb";
24option java_multiple_files = true;
25option java_outer_classname = "ExternalSystemProto";
26option java_package = "com.google.cloud.securitycenter.v1";
27option php_namespace = "Google\\Cloud\\SecurityCenter\\V1";
28option ruby_package = "Google::Cloud::SecurityCenter::V1";
29
30// Representation of third party SIEM/SOAR fields within SCC.
31message ExternalSystem {
32  option (google.api.resource) = {
33    type: "securitycenter.googleapis.com/ExternalSystem"
34    pattern: "organizations/{organization}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}"
35    pattern: "folders/{folder}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}"
36    pattern: "projects/{project}/sources/{source}/findings/{finding}/externalSystems/{externalsystem}"
37  };
38
39  // Information about the ticket, if any, that is being used to track the
40  // resolution of the issue that is identified by this finding.
41  message TicketInfo {
42    // The identifier of the ticket in the ticket system.
43    string id = 1;
44
45    // The assignee of the ticket in the ticket system.
46    string assignee = 2;
47
48    // The description of the ticket in the ticket system.
49    string description = 3;
50
51    // The link to the ticket in the ticket system.
52    string uri = 4;
53
54    // The latest status of the ticket, as reported by the ticket system.
55    string status = 5;
56
57    // The time when the ticket was last updated, as reported by the ticket
58    // system.
59    google.protobuf.Timestamp update_time = 6;
60  }
61
62  // Full resource name of the external system, for example:
63  // "organizations/1234/sources/5678/findings/123456/externalSystems/jira",
64  // "folders/1234/sources/5678/findings/123456/externalSystems/jira",
65  // "projects/1234/sources/5678/findings/123456/externalSystems/jira"
66  string name = 1;
67
68  // References primary/secondary etc assignees in the external system.
69  repeated string assignees = 2;
70
71  // The identifier that's used to track the finding's corresponding case in the
72  // external system.
73  string external_uid = 3;
74
75  // The most recent status of the finding's corresponding case, as reported by
76  // the external system.
77  string status = 4;
78
79  // The time when the case was last updated, as reported by the external
80  // system.
81  google.protobuf.Timestamp external_system_update_time = 5;
82
83  // The link to the finding's corresponding case in the external system.
84  string case_uri = 6;
85
86  // The priority of the finding's corresponding case in the external system.
87  string case_priority = 7;
88
89  // The SLA of the finding's corresponding case in the external system.
90  google.protobuf.Timestamp case_sla = 9;
91
92  // The time when the case was created, as reported by the external system.
93  google.protobuf.Timestamp case_create_time = 10;
94
95  // The time when the case was closed, as reported by the external system.
96  google.protobuf.Timestamp case_close_time = 11;
97
98  // Information about the ticket, if any, that is being used to track the
99  // resolution of the issue that is identified by this finding.
100  TicketInfo ticket_info = 8;
101}
102