Method: projects.locations.completeExternalIdentities

Cette méthode fournit des suggestions pour les utilisateurs et les groupes gérés dans un fournisseur d'identité externe, en fonction du préfixe fourni.

Requête HTTP


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

Les URL utilisent la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de l'établissement parent, par exemple projects/*/locations/global.

Paramètres de requête

Paramètres
prefixQuery

string

Obligatoire. Préfixe à rechercher. Pour les utilisateurs, ce préfixe est mis en correspondance avec primaryEmail. Pour les groupes, ce préfixe est mis en correspondance avec displayName. La mise en correspondance n'est pas sensible à la casse.
maxSuggestions

integer

Facultatif. Nombre maximal de résultats d'utilisateurs et de groupes à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, la recherche affiche six résultats au maximum. La limite est répartie aussi uniformément que possible entre les utilisateurs et les groupes. Par exemple, si maxSuggestions est défini sur 7, le service peut renvoyer 4 utilisateurs et 3 groupes. Si le nombre de suggestions d'un type est inférieur à la moitié de la limite, l'autre type peut renvoyer plus de suggestions, jusqu'à la limite maxSuggestions.
entityTypeFilter

enum (EntityTypeFilter)

Facultatif. Type d'entités à récupérer. Si ce paramètre n'est pas défini, tous les types d'entités seront renvoyés.
useScimIdentities

boolean

Facultatif. Indique si les identités SCIM doivent être utilisées pour compléter les identités externes. Si la valeur est "false", nous appellerons l'API Microsoft Graph pour récupérer les identités externes.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour CompletionService.CompleteExternalIdentities.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
Champs
externalIdentities[]

object (ExternalIdentity)

Liste des identités externes correspondant à la requête.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • 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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.locations.completeExternalIdentities

Pour en savoir plus, consultez la documentation IAM.

EntityTypeFilter

Type d'entités à récupérer.

Enums
ENTITY_TYPE_FILTER_UNSPECIFIED Filtre de type d'entité non spécifié.
USERS Utilisateurs avec accès "Exploration uniquement".
GROUPS Récupérer uniquement les groupes.

ExternalIdentity

Identité externe représentant un utilisateur ou un groupe. Cet utilisateur ou ce groupe provient d'un fournisseur d'identité (IdP) externe.

Représentation 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.
}
Champs
externalId

string

ID tiers unique(externalId) de l'entité (utilisateur ou groupe).
displayName

string

Nom à afficher de l'utilisateur ou du groupe.
subject

string

Uniquement en sortie. Représente l'identifiant de sujet IAM canonique (pour les utilisateurs) ou l'identifiant de groupe (pour les groupes), dérivé du mappage des revendications du pool de personnel. Si elle n'est pas définie, la logique personnalisée est utilisée.

Cette valeur doit être utilisée pour les liaisons IAM.
Type d'identité externe. Il permet d'indiquer le type d'entité (utilisateur ou groupe) et les métadonnées correspondantes. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
userMetadata

object (UserMetadata)

métadonnées correspondant à l'utilisateur externe.
groupMetadata

object (GroupMetadata)

métadonnées correspondant à l'utilisateur externe.
Fin des champs qui s'excluent mutuellement.

UserMetadata

métadonnées correspondant à l'utilisateur externe.

Représentation JSON 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
Champs
givenName

string

Prénom de l'utilisateur.
familyName

string

Nom de famille de l'utilisateur.
primaryEmail

string

Adresse e-mail principale de l'utilisateur. Ne l'utilisez pas pour les liaisons IAM. Utilisez ExternalIdentity.subject.

GroupMetadata

Ce type ne comporte aucun champ.

métadonnées correspondant au groupe externe.