Method: projects.locations.completeExternalIdentities

Diese Methode bietet Vorschläge für Nutzer und Gruppen, die in einem externen Identitätsanbieter verwaltet werden, basierend auf dem angegebenen Präfix.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Standortressource, z. B. projects/*/locations/global

Suchparameter

Parameter
prefixQuery

string

Erforderlich. Das Präfix, nach dem gesucht werden soll. Für Nutzer wird dieses Präfix mit der primaryEmail abgeglichen. Bei Gruppen wird dieses Präfix mit displayName abgeglichen. Beim Abgleich wird nicht zwischen Groß- und Kleinschreibung unterschieden.
maxSuggestions

integer

Optional. Die maximale Anzahl der zurückzugebenden Nutzer- und Gruppenergebnisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 6 Ergebnisse zurückgegeben. Das Limit wird so gleichmäßig wie möglich auf Nutzer und Gruppen verteilt. Wenn maxSuggestions beispielsweise 7 ist, gibt der Dienst möglicherweise 4 Nutzer und 3 Gruppen zurück. Wenn es weniger Vorschläge eines Typs als die Hälfte des Limits gibt, können für den anderen Typ mehr Vorschläge bis zum Limit „maxSuggestions“ zurückgegeben werden.
entityTypeFilter

enum (EntityTypeFilter)

Optional. Der Typ der abzurufenden Entitäten. Wenn nicht festgelegt, werden alle Entitätstypen zurückgegeben.
useScimIdentities

boolean

Optional. Gibt an, ob SCIM-Identitäten für die Vervollständigung externer Identitäten verwendet werden sollen. Wenn „false“ festgelegt ist, rufen wir die Microsoft Graph API auf, um die externen Identitäten abzurufen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für CompletionService.CompleteExternalIdentities.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
Felder
externalIdentities[]

object (ExternalIdentity)

Die Liste der externen Identitäten, die der Abfrage entsprechen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.locations.completeExternalIdentities

Weitere Informationen finden Sie in der IAM-Dokumentation.

EntityTypeFilter

Der Typ der abzurufenden Entitäten.

Enums
ENTITY_TYPE_FILTER_UNSPECIFIED Nicht angegebener Filter für den Entitätstyp.
USERS Nur Nutzer abrufen.
GROUPS Nur Gruppen abrufen.

ExternalIdentity

Externe Identität, die entweder einen Nutzer oder eine Gruppe darstellt. Dieser Nutzer oder diese Gruppe stammt von einem externen Identitätsanbieter (IdP).

JSON-Darstellung 
{
  "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.
}
Felder
externalId

string

Die eindeutige Drittanbieter-ID(externalId) der Identität (Nutzer oder Gruppe).
displayName

string

Der Anzeigename des Nutzers oder der Gruppe.
Union-Feld EntityType. Der Typ der externen Identität. Damit wird der Typ der Identität (Nutzer oder Gruppe) und die entsprechenden Metadaten angegeben. Für EntityType ist nur einer der folgenden Werte zulässig:
userMetadata

object (UserMetadata)

Metadaten, die dem externen Nutzer entsprechen.
groupMetadata

object (GroupMetadata)

Metadaten, die dem externen Nutzer entsprechen.

UserMetadata

Metadaten, die dem externen Nutzer entsprechen.

JSON-Darstellung 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
Felder
givenName

string

Der Vorname des Nutzers.
familyName

string

Der Nachname des Nutzers.
primaryEmail

string

Die primäre E-Mail-Adresse des Nutzers.

GroupMetadata

Dieser Typ hat keine Felder.

Metadaten, die der externen Gruppe entsprechen.