REST Resource: customers.v2.Users

资源：User

用户的 SCIM 表示。

JSON 表示法 
{
  "schemas": [
    string
  ],
  "emails": [
    {
      object (Email)
    }
  ],
  "addresses": [
    {
      object (Address)
    }
  ],
  "phoneNumbers": [
    {
      object (Phone)
    }
  ],
  "groups": [
    {
      object (GroupReference)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "userName": string,
  "name": {
    object (Name)
  },
  "displayName": string,
  "active": boolean,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    object (EnterpriseUserExtension)
  },
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser": {
    object (CloudIdentityUserExtension)
  }
}
字段
schemas[]

string

必需。一个 URI 列表，用于指示 SCIM 架构的命名空间，这些架构定义了当前 JSON 结构中存在的属性。只能包含为 User ResourceType 定义为 schema 和 schemaExtensions 的值。
emails[]

object (Email)

可选。用户的邮箱列表。允许的数据大小上限为 10KB。与 userName 对应的电子邮件地址会自动添加到此列表中，其 primary 子属性会设置为 true。此主邮箱条目为只读，无法通过此属性进行修改。
addresses[]

object (Address)

可选。用户的实际地址列表。允许的数据大小上限为 10KB。
phoneNumbers[]

object (Phone)

可选。用户的手机号码列表。允许的数据大小上限为 1KB。
groups[]

object (GroupReference)

仅限输出。用户直接加入的群组列表，最多截取 1, 000 个群组。

默认情况下，系统不会返回此属性，必须使用 attributes 查询参数进行请求。读取此属性需要将客户列入许可名单。请与支持团队联系，说明您的应用场景并申请访问权限。
id

string

标识符。用户的唯一 ID。属性特征为：caseExact 为 true，可变性为 readOnly，returned 特征为 always。
externalId

string

可选。SCIM 用户的客户端定义标识符。此字段区分大小写且可变。客户端负责确保唯一性，因为服务器不会强制执行此操作。
meta

object (Meta)

仅限输出。包含资源元数据的复杂属性。所有 meta 子属性均由服务提供商分配（mutability 为 readOnly），并且所有这些子属性的 returned 特征均为 default。如果此属性由客户端提供，则会被忽略。
userName

string

必需。用户的主邮箱。用作用户的唯一标识符。
name

object (Name)

必需。用户的姓名。
displayName

string

可选。用户的显示名称。限制：256 个字符。
active

boolean

可选。用户的账号状态（false 表示账号已中止）。默认值：true。
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object (EnterpriseUserExtension)

可选。SCIM 企业用户扩展属性。
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser

object (CloudIdentityUserExtension)

可选。SCIM Cloud Identity 用户扩展属性。

名称

用户名称的 SCIM 表示法。

JSON 表示法 
{
  "familyName": string,
  "givenName": string
}
字段
familyName

string

必需。用户的姓氏。
givenName

string

必需。用户的名字。

电子邮件

用户邮箱的 SCIM 表示法。

JSON 表示法 
{
  "value": string,
  "type": string,
  "primary": boolean
}
字段
value

string

必需。用户的电子邮件地址。
type

string

邮箱账号的类型。有效值为 home、work 和 other。
primary

boolean

仅限输出。指明这是否为用户的主邮箱。仅对于与 userName 对应的电子邮件，此值设置为 true。

地址

用户地址的 SCIM 表示法。

JSON 表示法 
{
  "formatted": string,
  "streetAddress": string,
  "locality": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "type": string,
  "primary": boolean
}
字段
formatted

string

完整地址，采用适合显示的格式。
streetAddress

string

街道地址。
locality

string

城市或地区。
region

string

地区或州。
postalCode

string

邮政编码。
country

string

国家/地区。
type

string

地址的类型。有效值为 home、work 和 other。
primary

boolean

指明这是否为用户的主要地址。

电话

用户手机号码的 SCIM 表示法。

JSON 表示法 
{
  "value": string,
  "type": string,
  "primary": boolean
}
字段
value

string

必需。手机号码。
type

string

手机号码的类型。有效值为 home、work、mobile、fax、pager 和 other。
primary

boolean

指明这是否为用户的主手机号码。

EnterpriseUserExtension

定义 SCIM 企业用户扩展程序的属性。此扩展程序的架构 URN 为：urn:ietf:params:scim:schemas:extension:enterprise:2.0:User。如需了解详情，请参阅 RFC 7643 第 4.3 节。

JSON 表示法 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string,
  "manager": {
    object (Manager)
  }
}
字段
employeeNumber

string

可选。标识符，通常由组织分配，用于在组织内标识用户。
costCenter

string

可选。用户支出所属的成本中心的标识符。
organization

string

可选。用户所属组织的名称。
department

string

可选。用户所属部门的名称（文本格式）。
manager

object (Manager)

可选。用户的管理者。一个复杂属性，可让服务提供商通过引用其他用户的 id 属性来表示组织层次结构。

管理员

用户主管的 SCIM 表示。字段基于 RFC 7643 第 4.3 节。

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

string

可选。代表用户主管的 SCIM 资源的 id。
$ref

string

仅限输出。代表用户主管的 SCIM 资源的 URI。

GroupReference

用户群组成员资格的 SCIM 表示法。

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

string

仅限输出。表示群组的 SCIM 资源的 id。
$ref

string

仅限输出。表示群组的 SCIM 资源的 URI。
type

string

仅限输出。群组成员资格类型。有效值为 direct 和 indirect。

CloudIdentityUserExtension

定义 Google Cloud Identity 用户扩展程序的属性。此扩展程序的架构 URN 为：urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityUser。

JSON 表示法 
{
  "websites": [
    {
      object (Website)
    }
  ],
  "additionalExternalIds": [
    {
      object (ExternalId)
    }
  ],
  "additionalIms": [
    {
      object (AdditionalIm)
    }
  ],
  "additionalOrganizations": [
    {
      object (AdditionalOrganization)
    }
  ],
  "addressListVisible": boolean,
  "gender": string,
  "organizationalUnit": {
    object (OrganizationalUnit)
  },
  "primaryOrganization": {
    object (PrimaryOrganization)
  }
}
字段
websites[]

object (Website)

可选。与用户关联的网站，不包括类型为 profile 的网站（对应于 SCIM 核心架构属性 profileUrl）。
additionalExternalIds[]

object (ExternalId)

可选。用户的外部标识符集合。此列表是对 SCIM 核心架构属性 externalId 和 SCIM 企业用户扩展属性 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber 所代表的属性集的补充。
additionalIms[]

object (AdditionalIm)

可选。用户的非主要即时通讯地址。排除主 IM 地址，这些地址对应于 SCIM 核心架构属性 ims。
additionalOrganizations[]

object (AdditionalOrganization)

可选。用户的非主要组织。
addressListVisible

boolean

可选。指明是否应在全局地址列表中显示该用户。如果客户端未分配或清除了此属性，则此属性默认为 true。
gender

string

可选。用户的性别。支持的值包括 female、male、other 和 unknown。系统还支持自定义值；任何其他字符串值都会被视为自定义性别。
organizationalUnit

object (OrganizationalUnit)

可选。用户所属的组织部门。
primaryOrganization

object (PrimaryOrganization)

可选。用户所属主要组织的其他属性。不包括 name、department 和 costCenter（由 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 表示），以及 title（对应于 SCIM 核心架构属性 title）。

OrganizationalUnit

用户所属组织部门的 SCIM 表示。

JSON 表示法 
{
  "path": string
}
字段
path

string

可选。用户所属组织部门的完整路径（例如 /corp/engineering），或顶级组织部门的 /。组织部门必须已经存在。如果客户端未分配或清除了此属性，则此属性默认为 /。

网站

用户网站的 SCIM 表示形式。排除类型为 profile 的网站，这些网站对应于 SCIM 核心架构属性 profileUrl。

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

string

必需。网站网址。
type

string

可选。网站的类型。支持的值包括 home、work 和 other。除 home 或 work 之外的任何输入值都会被视为 other。

ExternalId

用户额外外部标识符的 SCIM 表示。不包括已由 SCIM 核心架构属性 externalId 和 SCIM 企业用户扩展属性 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber 表示的外部标识符。

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

string

必需。外部 ID 的值。
type

string

可选。外部 ID 的类型。支持的值包括 account、customer、loginId 和 network。系统还支持自定义值；任何其他字符串值都会被视为自定义类型。值 organization 和 cloudidentityscim.googleapis.com 已预留，无法使用。

AdditionalIm

用户非主要即时通讯 (IM) 地址的 SCIM 表示法。排除主 IM 地址，这些地址对应于 SCIM 核心架构属性 ims。

JSON 表示法 
{
  "value": string,
  "usage": string,
  "type": string
}
字段
value

string

必需。即时通讯地址。
usage

string

可选。IM 的使用情况。支持的值包括 home、work 和 other。系统还支持自定义值；任何其他字符串值都会被视为自定义用途。
type

string

可选。即时通讯服务的类型。支持的值包括 aim、gtalk、icq、jabber、msn、netmeeting、qq、skype 和 yahoo。系统还支持自定义值；任何其他字符串值都会被视为自定义类型。

PrimaryOrganization

用户主要组织的 SCIM 表示。此复杂属性中的字段适用于与 SCIM 企业用户扩展 (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User) 相同的主要组织。它不包括 name、department 和 costCenter（由 urn:ietf:params:scim:schemas:extension:enterprise:2.0:User 中的 organization、department 和 costCenter 属性表示），也不包括 title（对应于 SCIM 核心架构属性 title）。

JSON 表示法 
{
  "type": string,
  "domain": string,
  "fullTimeEquivalent": integer,
  "location": string,
  "symbol": string
}
字段
type

string

可选。组织的类型。有效值为 school 和 work。
domain

string

可选。与组织关联的域名。例如 example.com。
fullTimeEquivalent

integer

可选。组织内的全职当量千分比（100000 = 100%）。
location

string

可选。组织的实际位置。
symbol

string

可选。组织的股票代码。

AdditionalOrganization

用户非主要组织的 SCIM 表示。不包括用户的主要组织，该组织通过 primaryOrganization 属性、SCIM 企业用户扩展程序 (urn:ietf:params:scim:schemas:extension:enterprise:2.0:User) 和 SCIM 核心架构属性 title 表示。

JSON 表示法 
{
  "type": string,
  "costCenter": string,
  "department": string,
  "domain": string,
  "fullTimeEquivalent": integer,
  "location": string,
  "name": string,
  "symbol": string,
  "title": string
}
字段
type

string

可选。组织的类型。有效值为 school 和 work。
costCenter

string

可选。组织的成本中心。
department

string

可选。组织的部门。
domain

string

可选。与组织关联的域名。例如 example.com。
fullTimeEquivalent

integer

可选。组织内的全职当量千分比（100000 = 100%）。
location

string

可选。组织的实际位置。
name

string

可选。机构的名称。
symbol

string

可选。组织的股票代码。
title

string

可选。用户在组织中的职位。

方法

create

 创建用户。

delete

 删除用户。

get

 检索用户。

list

 检索用户列表。

patch

 使用 SCIM 补丁语义更新用户。