Method: projects.locations.completeExternalIdentities

Questo metodo fornisce suggerimenti per utenti e gruppi gestiti in un provider di identità esterno, in base al prefisso fornito.

Richiesta HTTP


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

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa di località padre, ad esempio projects/*/locations/global.

Parametri di query

Parametri
prefixQuery

string

Obbligatorio. Il prefisso da cercare. Per gli utenti, questo prefisso viene confrontato con primaryEmail. Per i gruppi, questo prefisso viene confrontato con displayName. La corrispondenza non distingue tra maiuscole e minuscole.
maxSuggestions

integer

Facoltativo. Il numero massimo di risultati di utenti e gruppi da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore.

Se non specificato, verranno restituiti al massimo 6 risultati. Il limite viene distribuito nel modo più uniforme possibile tra utenti e gruppi. Ad esempio, se maxSuggestions è 7, il servizio potrebbe restituire 4 utenti e 3 gruppi. Se ci sono meno suggerimenti di un tipo rispetto alla metà del limite, l'altro tipo può restituire più suggerimenti fino al limite maxSuggestions.
entityTypeFilter

enum (EntityTypeFilter)

Facoltativo. Il tipo di entità da recuperare. Se non è impostato, verranno restituiti tutti i tipi di entità.
useScimIdentities

boolean

Facoltativo. Indica se utilizzare le identità SCIM per il completamento delle identità esterne. Se è false, chiameremo l'API Microsoft Graph per recuperare le identità esterne.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per CompletionService.CompleteExternalIdentities.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
Campi
externalIdentities[]

object (ExternalIdentity)

L'elenco delle identità esterne che corrispondono alla query.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.locations.completeExternalIdentities

Per saperne di più, consulta la documentazione di IAM.

EntityTypeFilter

Il tipo di entità da recuperare.

Enum
ENTITY_TYPE_FILTER_UNSPECIFIED Filtro per tipo di entità non specificato.
USERS Recupera solo gli utenti.
GROUPS Recupera solo i gruppi.

ExternalIdentity

Identità esterna che rappresenta un utente o un gruppo. Questo utente o gruppo proviene da un provider di identità (IdP) esterno.

Rappresentazione 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.
}
Campi
externalId

string

L'ID univoco di terze parti(externalId) dell'entità (utente o gruppo).
displayName

string

Il nome visualizzato dell'utente o del gruppo.
subject

string

Solo output. Rappresenta l'identificatore soggetto IAM canonico (per gli utenti) o l'identificatore gruppo (per i gruppi), derivato dalla mappatura delle attestazioni del pool di identità della forza lavoro. Se non è impostato, viene utilizzata la logica personalizzata.

Deve essere utilizzato per le associazioni IAM.
Il tipo di identità esterna. Viene utilizzato per indicare il tipo di entità (utente o gruppo) e i metadati corrispondenti. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
userMetadata

object (UserMetadata)

metadati corrispondenti all'utente esterno.
groupMetadata

object (GroupMetadata)

metadati corrispondenti all'utente esterno.
Fine dei campi che si escludono a vicenda.

UserMetadata

metadati corrispondenti all'utente esterno.

Rappresentazione JSON 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
Campi
givenName

string

Il nome dell'utente.
familyName

string

Il cognome dell'utente.
primaryEmail

string

L'indirizzo email principale dell'utente. Non utilizzare questo campo per i binding IAM. Utilizza ExternalIdentity.subject.

GroupMetadata

Questo tipo non ha campi.

metadati corrispondenti al gruppo esterno.