×

POST /v1/permissionsets

PostPermissionSet

描述

请求中不允许使用 PermissionSet.id,并在响应中设置。

参数

正文参数

名称 描述 必需 默认值 模式

正文

这编码了一组 StackRox 资源的权限。StoragePermissionSet

X

返回类型

内容类型

  • application/json

响应

表 1. HTTP 响应代码
代码 消息 数据类型

200

成功的响应。

StoragePermissionSet

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

GooglerpcStatus

字段名称 必需 可为空 类型 描述 格式

代码

整数

int32

消息

字符串

详情

ProtobufAny 列表

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 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

字符串

唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须至少包含一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称(如path/google.protobuf.Duration)。名称应采用规范形式(例如,不接受前导“.”)。实际上,团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是,对于使用方案httphttps或无方案的 URL,可以选择设置一个类型服务器,将类型 URL 映射到消息定义,如下所示:* 如果未提供方案,则假定为https。* 对 URL 的 HTTP GET 必须产生二进制格式的[google.protobuf.Type][]值,或产生错误。* 应用程序可以根据 URL 缓存查找结果,或将其预编译到二进制文件中以避免任何查找。因此,需要在类型更改时保留二进制兼容性。(使用版本化的类型名称来管理重大更改。)注意:此功能当前在官方 protobuf 版本中不可用,并且不适用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月,没有广泛使用的类型服务器实现,也没有计划实现一个。可能使用除httphttps(或空方案)以外的方案,并具有特定于实现的语义。

StorageAccess

枚举值

NO_ACCESS(无访问权限)

READ_ACCESS(读取访问权限)

READ_WRITE_ACCESS(读写访问权限)

StoragePermissionSet

这编码了一组 StackRox 资源的权限。

字段名称 必需 可为空 类型 描述 格式

id

字符串

id 是生成的,不能更改。

名称

字符串

namedescription由用户提供,可以更改。

描述

字符串

resourceToAccess

StorageAccess 的映射

特性

StorageTraits

StorageTraits

字段名称 必需 可为空 类型 描述 格式

可变性模式

TraitsMutabilityMode

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

可见性

TraitsVisibility

VISIBLE(可见), HIDDEN(隐藏),

来源

TraitsOrigin

IMPERATIVE(强制性), DEFAULT(默认), DECLARATIVE(声明式), DECLARATIVE_ORPHANED(声明式孤立),

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:对象是通过声明性配置创建的,然后未能删除(例如,因为它被另一个对象引用)。根据来源,不同的规则适用于对象。不允许通过 API 修改具有 DECLARATIVE 来源的对象,只能通过声明性配置修改。此外,它们可能不会引用具有 IMPERATIVE 来源的对象。不允许通过 API 或声明性配置修改具有 DEFAULT 来源的对象。它们可以被所有其他对象引用。允许通过 API 修改具有 IMPERATIVE 来源的对象,但不能通过声明性配置修改。它们可以引用所有其他对象。不允许通过 API 或声明性配置修改具有 DECLARATIVE_ORPHANED 来源的对象。如果在声明性配置中重新定义,DECLARATIVE_ORPHANED 资源可以再次成为 DECLARATIVE。不再被其他资源引用后,具有此来源的对象将立即从系统中清除。它们可以被所有其他对象引用。

枚举值

IMPERATIVE(强制性)

DEFAULT(默认)

DECLARATIVE(声明式)

DECLARATIVE_ORPHANED(声明式孤立)

TraitsVisibility

实验性。visibility 允许指定对象是否应对某些 API 可见。

枚举值

VISIBLE(可见)

HIDDEN(隐藏)