Method: projects.locations.completeExternalIdentities

Este método proporciona sugerencias para los usuarios y los grupos que se administran en un proveedor de identidad externo, según el prefijo proporcionado.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. El nombre del recurso de ubicación superior, como projects/*/locations/global.

Parámetros de consulta

Parámetros
prefixQuery

string

Obligatorio. El prefijo que se debe buscar. Para los usuarios, este prefijo se compara con primaryEmail. Para los grupos, este prefijo se compara con displayName. La coincidencia no distingue mayúsculas de minúsculas.
maxSuggestions

integer

Es opcional. La cantidad máxima de resultados de usuarios y grupos que se mostrarán. El servicio puede mostrar menos que este valor.

Si no se especifica, se mostrarán como máximo 6 resultados. El límite se distribuye de la manera más uniforme posible entre los usuarios y los grupos. Por ejemplo, si maxSuggestions es 7, el servicio puede mostrar 4 usuarios y 3 grupos. Si hay menos sugerencias de un tipo que la mitad del límite, el otro tipo puede mostrar más sugerencias hasta el límite de maxSuggestions.
entityTypeFilter

enum (EntityTypeFilter)

Es opcional. El tipo de entidades que se recuperarán. Si no se establece, se mostrarán todos los tipos de entidades.
useScimIdentities

boolean

Es opcional. Indica si se deben usar identidades SCIM para completar la identidad externa. Si es falso, llamaremos a la API de Microsoft Graph para recuperar las identidades externas.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje de respuesta para CompletionService.CompleteExternalIdentities.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
Campos
externalIdentities[]

object (ExternalIdentity)

La lista de identidades externas que coinciden con la consulta.

Permisos de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • discoveryengine.locations.completeExternalIdentities

Para obtener más información, consulta la documentación de IAM.

EntityTypeFilter

El tipo de entidades que se recuperarán.

Enums
ENTITY_TYPE_FILTER_UNSPECIFIED Filtro de tipo de entidad no especificado.
USERS Recupera solo usuarios.
GROUPS Recupera solo grupos.

ExternalIdentity

Identidad externa que representa a un usuario o un grupo. Este usuario o grupo proviene de un proveedor de identidad externo (IdP).

Representación JSON 
{
  "externalId": string,
  "displayName": string,

  // Union field EntityType can be only one of the following:
  "userMetadata": {
    object (UserMetadata)
  },
  "groupMetadata": {
    object (GroupMetadata)
  }
  // End of list of possible types for union field EntityType.
}
Campos
externalId

string

El ID único de terceros(externalId) de la entidad (usuario o grupo).
displayName

string

El nombre visible del usuario o del grupo.
Campo de unión EntityType. El tipo de identidad externa. Se usa para indicar el tipo de entidad (usuario o grupo) y los metadatos correspondientes. EntityType puede ser solo uno de los parámetros siguientes:
userMetadata

object (UserMetadata)

Metadatos correspondientes al usuario externo.
groupMetadata

object (GroupMetadata)

Metadatos correspondientes al usuario externo.

UserMetadata

Metadatos correspondientes al usuario externo.

Representación JSON 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
Campos
givenName

string

El nombre del usuario.
familyName

string

El apellido del usuario.
primaryEmail

string

La dirección de correo electrónico principal del usuario.

GroupMetadata

Este tipo no tiene campos.

Metadatos correspondientes al grupo externo.