Method: projects.locations.completeExternalIdentities

Este método proporciona sugerencias para los usuarios y 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

Las URL usan la sintaxis de transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. Es el nombre del recurso de la ubicación principal, como projects/*/locations/global.

Parámetros de consulta

Parámetros
prefixQuery

string

Obligatorio. Es el prefijo que se buscará. Para los usuarios, este prefijo se compara con el primaryEmail. En el caso de los grupos, este prefijo se compara con el displayName. La coincidencia no distingue mayúsculas de minúsculas.
maxSuggestions

integer

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

Si no se especifica, se devolverá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 devolver 4 usuarios y 3 grupos. Si hay menos sugerencias de un tipo que la mitad del límite, el otro tipo puede devolver más sugerencias hasta el límite de maxSuggestions.
entityTypeFilter

enum (EntityTypeFilter)

Es opcional. Es el tipo de entidades que se recuperarán. Si no se configura, se devolverán todos los tipos de entidades.
useScimIdentities

boolean

Es opcional. Indica si se deben usar identidades de SCIM para completar identidades externas. 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)

Es la lista de identidades externas que coinciden con la búsqueda.

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

Es el tipo de entidades que se recuperarán.

Enums
ENTITY_TYPE_FILTER_UNSPECIFIED Es un filtro de tipo de entidad sin especificar.
USERS Solo se recuperan los usuarios.
GROUPS Recupera solo los grupos.

ExternalIdentity

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

Representación 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.
}
Campos
externalId

string

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

string

Es el nombre visible del usuario o grupo.
subject

string

Solo salida. Representa el identificador canónico del sujeto de IAM (para usuarios) o el identificador de grupo (para grupos), derivado de la asignación de reclamaciones de workforce-pool. Si no se configura, se recurre a la lógica personalizada.

Se debe usar para las vinculaciones de IAM.
Es el tipo de identidad externa. Se usa para indicar el tipo de entidad (usuario o grupo) y los metadatos correspondientes. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
userMetadata

object (UserMetadata)

Son los metadatos correspondientes al usuario externo.
groupMetadata

object (GroupMetadata)

Son los metadatos correspondientes al usuario externo.
Fin de los campos mutuamente excluyentes.

UserMetadata

Son los metadatos correspondientes al usuario externo.

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

string

Nombre de pila del usuario.
familyName

string

Apellido del usuario
primaryEmail

string

Es la dirección de correo electrónico principal del usuario. No uses este método para las vinculaciones de IAM. Usa ExternalIdentity.subject.

GroupMetadata

Este tipo no tiene campos.

Son los metadatos correspondientes al grupo externo.