Method: projects.locations.completeExternalIdentities

此方法会根据提供的字词前缀，为在外部身份提供方中管理的用户和群组提供建议。

HTTP 请求

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}:completeExternalIdentities

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。父级位置的资源名称，例如 projects/*/locations/global。

查询参数

参数
prefixQuery

string

必需。要搜索的字词前缀。对于用户，此字词前缀与 primaryEmail 匹配。对于群组，此字词前缀与 displayName 匹配。匹配不区分大小写。
maxSuggestions

integer

可选。要返回的用户和群组结果数量上限。服务返回的值可能小于此值。

如果未指定，则最多返回 6 个结果。此限制会尽可能均匀地分配给用户和群组。例如，如果 maxSuggestions 为 7，则服务可能会返回 4 个用户和 3 个群组。如果某一种类型的建议数量少于限制的一半，则另一种类型可能会返回更多建议，但不会超过 maxSuggestions 限制。
entityTypeFilter

enum (EntityTypeFilter)

可选。要提取的实体类型。如果未设置，则会返回所有实体类型。
useScimIdentities

boolean

可选。是否使用 scim 身份来完成外部身份。如果为 false，我们将调用 Microsoft Graph API 来提取外部身份。

请求正文

请求正文必须为空。

响应正文

CompletionService.CompleteExternalIdentities 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
字段
externalIdentities[]

object (ExternalIdentity)

与查询匹配的外部身份列表。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

如需了解详情，请参阅 Authentication Overview。

IAM 权限

需要拥有 parent 资源的以下 IAM 权限：

  • discoveryengine.locations.completeExternalIdentities

如需了解详情，请参阅 IAM 文档。

EntityTypeFilter

要提取的实体类型。

枚举
ENTITY_TYPE_FILTER_UNSPECIFIED 未指定的实体类型过滤器。
USERS 仅提取用户。
GROUPS 仅提取群组。

ExternalIdentity

表示用户或群组的外部身份。此用户或群组来自外部身份提供方 (IdP)。

JSON 表示法 
{
  "externalId": string,
  "displayName": string,
  "subject": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userMetadata": {
    object (UserMetadata)
  },
  "groupMetadata": {
    object (GroupMetadata)
  }
  // End of mutually exclusive fields.
}
字段
externalId

string

实体的唯一第三方 ID (externalId)（用户或群组）。
displayName

string

用户或群组的显示名。
subject

string

仅限输出。表示规范 IAM 正文标识符（对于用户）或群组标识符（对于群组），派生自员工池声明映射。如果未设置，则回退到自定义逻辑。

这必须用于 IAM 绑定。
外部身份的类型。这用于指示实体类型（用户或群组）和相应的元数据。以下是互斥字段的列表。在响应中，最多会设置一个字段：
userMetadata

object (UserMetadata)

与外部用户对应的元数据。
groupMetadata

object (GroupMetadata)

与外部用户对应的元数据。
互斥字段结束。

UserMetadata

与外部用户对应的元数据。

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

string

用户的名字。
familyName

string

用户的姓氏。
primaryEmail

string

用户的主邮箱。请勿将其用于 IAM 绑定。请使用 ExternalIdentity.subject。

GroupMetadata

此类型没有字段。

与外部群组对应的元数据。