REST Resource: customers.v2.Groups

资源:群组

群组的 SCIM 表示法。

JSON 表示法
{
  "schemas": [
    string
  ],
  "members": [
    {
      object (Member)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "displayName": string,
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup": {
    object (CloudIdentityGroupExtension)
  }
}
字段
schemas[]

string

必需。URI 列表,用于指明 SCIM 架构的命名空间,这些架构定义了当前 JSON 结构中存在的属性。必须仅包含为群组 ResourceType 定义为 schema 和 schemaExtensions 的值。

members[]

object (Member)

可选。此群组中的成员列表。目前不会返回此属性。可以通过 PATCH 请求修改群组成员资格。

id

string

标识符。群组的唯一 ID。此属性的特征为 caseExact 为 true、可变性为 readOnly,且 returned 特征为 always。

externalId

string

可选。由预配客户端定义的资源的标识符。

meta

object (Meta)

仅限输出。资源元数据。所有子属性的可变性均为 readOnly,且 returned 特征为 default。

displayName

string

必需。群组的显示名称。

urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup

object (CloudIdentityGroupExtension)

必需。Cloud Identity 特定的群组属性。

成员

群组成员的 SCIM 表示法。

JSON 表示法
{
  "value": string,
  "$ref": string
}
字段
value

string

不可变。此群组成员的标识符。

$ref

string

不可变。成员的 URI。

CloudIdentityGroupExtension

定义 Google Cloud Identity 群组扩展的属性。此扩展的架构 URN 为:urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup。

JSON 表示法
{
  "email": string,
  "description": string
}
字段
email

string

必需。群组的电子邮件地址。如果您的账号有多个网域,请为电子邮件地址选择合适的网域。email 必须是唯一的。群组电子邮件地址必须遵守与用户名相同的字符使用规则。如需了解详情,请参阅帮助中心文档。

description

string

可选。扩展说明,可帮助用户确定 Group 的用途。

限制:最多 4,096 个字符。

方法

create

创建群组。

delete

删除群组。

get

检索群组。

list

检索群组列表。

patch

使用 SCIM 修补语义更新群组。