client certificate which is used for authentication
×
TestUpdatedNotifier
POST /v1/notifiers/test/updated
TestUpdatedNotifier 检查给定的通知器是否配置正确，并可以选择进行存储的凭据协调。
常用对象引用
GooglerpcStatus
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
代码 |
整数 |
int32 |
|||
消息 |
字符串 |
||||
详情 |
ProtobufAny 列表 |
JiraPriorityMapping
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
严重性 |
UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, |
||||
优先级名称 |
字符串 |
MicrosoftSentinelClientCertAuthConfig
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
客户端证书 |
字符串 |
PEM 编码的 ASN.1 DER 格式。 |
|||
私钥 |
字符串 |
PEM 编码的 PKCS #8，ASN.1 DER 格式。 |
MicrosoftSentinelDataCollectionRuleConfig
DataCollectionRuleConfig 包含数据收集规则的信息，每个通知程序类型对应一个配置。
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
streamName（流名称） |
字符串 |
||||
dataCollectionRuleId（数据收集规则 ID） |
字符串 |
||||
enabled（启用） |
布尔值 |
ProtobufAny
Any 包含任意序列化的 Protocol Buffer 消息，以及描述序列化消息类型的 URL。
Protobuf 库提供支持，以实用函数或 Any 类型的附加生成方法的形式打包/解包 Any 值。
示例 1：在 C++ 中打包和解包消息。
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
示例 2：在 Java 中打包和解包消息。
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
Protobuf 库提供的打包方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL，解包方法仅使用类型 URL 中最后一个 '/' 后的完全限定类型名称，例如 "foo.bar.com/x/y.z" 将产生类型名称 "y.z"。
JSON 表示
Any 值的 JSON 表示使用反序列化的嵌入式消息的常规表示，并增加一个包含类型 URL 的附加字段 @type。示例
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
如果嵌入式消息类型是众所周知的并且具有自定义 JSON 表示，则该表示将被嵌入，并添加一个字段 value，该字段除了 @type 字段外还包含自定义 JSON。示例（对于消息 [google.protobuf.Duration][]）
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
@type |
字符串 |
一个唯一标识序列化 Protocol Buffer 消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一个段必须表示类型的完全限定名称（如 |
StorageAWSSecurityHubCredentials
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
accessKeyId（访问密钥 ID） |
字符串 |
||||
secretAccessKey（密钥） |
字符串 |
||||
stsEnabled（STS 启用） |
布尔值 |
StorageCSCC
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
serviceAccount（服务账户） |
字符串 |
集成使用的服务账户。服务器将在响应和日志中屏蔽此凭据的值。 |
|||
sourceId（源 ID） |
字符串 |
||||
wifEnabled（WIF 启用） |
布尔值 |
StorageEmail
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
server（服务器） |
字符串 |
||||
sender（发件人） |
字符串 |
||||
username（用户名） |
字符串 |
||||
password（密码） |
字符串 |
集成使用的密码。服务器将在响应和日志中屏蔽此凭据的值。 |
|||
disableTLS |
布尔值 |
||||
已弃用，请使用 StartTLS |
布尔值 |
||||
from（发件人地址） |
字符串 |
||||
startTLSAuthMethod（StartTLS 身份验证方法） |
DISABLED, PLAIN, LOGIN, |
||||
allowUnauthenticatedSmtp（允许未经身份验证的 SMTP） |
布尔值 |
StorageGeneric
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
endpoint（端点） |
字符串 |
||||
skipTLSVerify（跳过 TLS 验证） |
布尔值 |
||||
caCert（CA 证书） |
字符串 |
||||
username（用户名） |
字符串 |
||||
password（密码） |
字符串 |
集成使用的密码。服务器将在响应和日志中屏蔽此凭据的值。 |
|||
headers（头部） |
|||||
extraFields（额外字段） |
|||||
auditLoggingEnabled（审计日志记录启用） |
布尔值 |
StorageJira
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
url（URL） |
字符串 |
||||
username（用户名） |
字符串 |
||||
password（密码） |
字符串 |
集成使用的密码。服务器将在响应和日志中屏蔽此凭据的值。 |
|||
issueType（问题类型） |
字符串 |
||||
priorityMappings（优先级映射） |
|||||
defaultFieldsJson（默认字段 JSON） |
字符串 |
||||
disablePriority（禁用优先级） |
布尔值 |
StorageMicrosoftSentinel
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
logIngestionEndpoint（日志摄取端点） |
字符串 |
log_ingestion_endpoint 是日志摄取端点。 |
|||
directoryTenantId（目录租户 ID） |
字符串 |
directory_tenant_id 包含所选租户的 Microsoft 目录 ID。 |
|||
applicationClientId（应用程序客户端 ID） |
字符串 |
application_client_id 包含服务主体的应用程序 ID。 |
|||
secret（密钥） |
字符串 |
secret 包含客户端密钥。 |
|||
alertDcrConfig（告警 DCR 配置） |
|||||
auditLogDcrConfig（审计日志 DCR 配置） |
|||||
clientCertAuthConfig（客户端证书身份验证配置） |
StorageNotifier
Next Tag: 21
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
id（ID） |
字符串 |
||||
name（名称） |
字符串 |
||||
type（类型） |
字符串 |
||||
uiEndpoint（UI 端点） |
字符串 |
||||
labelKey（标签键） |
字符串 |
||||
labelDefault（标签默认值） |
字符串 |
||||
jira |
|||||
cscc |
|||||
splunk |
|||||
pagerduty |
|||||
generic |
|||||
sumologic |
|||||
awsSecurityHub |
|||||
syslog |
|||||
microsoftSentinel |
|||||
notifierSecret（通知程序密钥） |
字符串 |
||||
traits（特性） |
StorageSeverity
| 枚举值 |
|---|
UNSET_SEVERITY（未设置严重性） |
LOW_SEVERITY（低严重性） |
MEDIUM_SEVERITY（中严重性） |
HIGH_SEVERITY（高严重性） |
CRITICAL_SEVERITY（严重性） |
StorageSplunk
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
httpToken（HTTP 令牌） |
字符串 |
集成使用的 HTTP 令牌。服务器将在响应和日志中屏蔽此凭据的值。 |
|||
httpEndpoint（HTTP 端点） |
字符串 |
||||
insecure（不安全） |
布尔值 |
||||
truncate（截断） |
字符串 |
int64（64 位整数） |
|||
auditLoggingEnabled（审计日志记录启用） |
布尔值 |
||||
derivedSourceType（派生源类型） |
布尔值 |
||||
sourceTypes（源类型） |
|
StorageSyslog
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
localFacility（本地设备） |
LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7, |
||||
tcpConfig（TCP 配置） |
|||||
extraFields（额外字段） |
|||||
messageFormat（消息格式） |
LEGACY, CEF, |
StorageTraits
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
mutabilityMode（可变性模式） |
ALLOW_MUTATE, ALLOW_MUTATE_FORCED, |
||||
visibility（可见性） |
VISIBLE, HIDDEN, |
||||
origin（来源） |
IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
SyslogTCPConfig
| 字段名称 | 必需 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
hostname（主机名） |
字符串 |
||||
port（端口） |
整数 |
int32 |
|||
skipTlsVerify（跳过 TLS 验证） |
布尔值 |
||||
useTls（使用 TLS） |
布尔值 |
TraitsMutabilityMode
实验性。注意：请暂时避免使用 MutabilityMode。它将在未来被替换（ROX-14276）。MutabilityMode 指定对象是否以及如何修改。默认为 ALLOW_MUTATE，表示没有修改限制；这等效于没有 MutabilityMode 说明。ALLOW_MUTATE_FORCED 禁止所有修改操作，除了强制位开启的对象删除。
更改此字段的状态时请小心。例如，将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED 是允许的，但这将禁止对它的任何进一步更改，包括将其修改回 ALLOW_MUTATE。
| 枚举值 |
|---|
ALLOW_MUTATE（允许修改） |
ALLOW_MUTATE_FORCED（强制允许修改） |
TraitsOrigin
Origin 指定对象的来源。对象可以有四种不同的来源：- 强制性 (IMPERATIVE)：对象是通过 API 创建的。这是默认假设。- 默认 (DEFAULT)：对象是默认对象，例如默认角色、访问范围等。- 声明式 (DECLARATIVE)：对象是通过声明式配置创建的。- 声明式孤儿 (DECLARATIVE_ORPHANED)：对象是通过声明式配置创建的，然后未能成功删除（例如，因为它被另一个对象引用）。根据来源，不同的规则适用于不同的对象。具有 DECLARATIVE 来源的对象不允许通过 API 修改，只能通过声明式配置修改。此外，它们可能不能引用具有 IMPERATIVE 来源的对象。具有 DEFAULT 来源的对象不允许通过 API 或声明式配置进行修改。它们可以被所有其他对象引用。具有 IMPERATIVE 来源的对象允许通过 API 修改，不允许通过声明式配置修改。它们可以引用所有其他对象。具有 DECLARATIVE_ORPHANED 来源的对象不允许通过 API 或声明式配置修改。如果在声明式配置中重新定义，DECLARATIVE_ORPHANED 资源可以再次变为 DECLARATIVE。具有此来源的对象在其不再被其他资源引用后将立即从系统中清除。它们可以被所有其他对象引用。
| 枚举值 |
|---|
强制性 (IMPERATIVE) |
默认 (DEFAULT) |
声明式 (DECLARATIVE) |
声明式孤儿 (DECLARATIVE_ORPHANED) |