Method: projects.locations.completeExternalIdentities

Bei dieser Methode werden Vorschläge für Nutzer und Gruppen bereitgestellt, die in einem externen Identitätsanbieter verwaltet werden. Die Vorschläge basieren auf dem angegebenen Präfix.

HTTP-Anfrage

:


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

Für die URLs wird die Syntax der gRPC-Transcodierung verwendet.

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 dem primaryEmail abgeglichen. Bei Gruppen wird dieses Präfix mit displayName abgeglichen. Dabei 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 sechs Ergebnisse zurückgegeben. Das Limit wird so gleichmäßig wie möglich auf Nutzer und Gruppen verteilt. Wenn „maxSuggestions“ beispielsweise auf 7 festgelegt 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 zurückgegeben werden, bis zum Limit „maxSuggestions“.
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“, 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 Anfrage 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 (Identity Provider, IdP).

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

string

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

string

Der Anzeigename des Nutzers oder der Gruppe.
subject

string

Nur Ausgabe. Stellt die kanonische IAM-Subjekt-ID (für Nutzer) oder Gruppen-ID (für Gruppen) dar, die aus dem Workforce-Pool-Claim-Mapping abgeleitet wird. Wenn nicht festgelegt, wird auf benutzerdefinierte Logik zurückgegriffen.

Dies muss für IAM-Bindungen verwendet werden.
Der Typ der externen Identität. Damit wird der Typ der Identität (Nutzer oder Gruppe) und die entsprechenden Metadaten angegeben. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
userMetadata

object (UserMetadata)

Metadaten, die dem externen Nutzer entsprechen.
groupMetadata

object (GroupMetadata)

Metadaten, die dem externen Nutzer entsprechen.
Ende der sich gegenseitig ausschließenden Felder.

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. Verwenden Sie diese Funktion nicht für IAM-Bindungen. Verwenden Sie ExternalIdentity.subject.

GroupMetadata

Dieser Typ hat keine Felder.

Metadaten, die der externen Gruppe entsprechen.