Method: projects.tenants.patch

Aktualisiert den angegebenen Mandanten.

HTTP-Anfrage

PATCH https://jobs.googleapis.com/v4beta1/{tenant.name=projects/*/tenants/*}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
tenant.name

string

Erforderlich während des Mandantenupdates.

Der Ressourcenname für einen Mandanten. Sie wird vom Dienst generiert, wenn ein Mandant erstellt wird.

Das Format ist „projects/{projectId}/Mandanten/{MandantenId}“, z. B. „projects/foo/Mandanten/bar“.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "tenant": {
    "name": string,
    "externalId": string,
    "usageType": enum (DataUsageType),
    "keywordSearchableProfileCustomAttributes": [
      string
    ]
  },
  "updateMask": string
}
Felder
tenant.externalId

string

Erforderlich. Clientseitige Mandanten-ID zur eindeutigen Identifizierung des Mandanten.

Es sind maximal 255 Zeichen zulässig.

tenant.usageType

enum (DataUsageType)

Gibt an, ob Daten, die diesem Mandanten gehören, verwendet werden können, um Produktverbesserungen für andere Mandanten bereitzustellen.

Wenn kein Wert festgelegt ist, gilt standardmäßig DataUsageType.ISOLATED.

tenant.keywordSearchableProfileCustomAttributes[]

string

Eine Liste mit Schlüsseln mit filterbaren Profile.custom_attributes, deren entsprechende stringValues in Stichwortsuchen verwendet werden. Profile mit stringValues unter diesen angegebenen Feldschlüsseln werden zurückgegeben, wenn einer der Werte mit dem Suchbegriff der Suche übereinstimmt. Benutzerdefinierte Feldwerte mit Klammern und Sonderzeichen können nicht unverändert durchsucht werden und müssen in Anführungszeichen gesetzt werden.

updateMask

string (FieldMask format)

Dringend empfohlen für eine optimale Servicequalität.

Wenn updateMask angegeben ist, werden nur die angegebenen Felder in tenant aktualisiert. Andernfalls werden alle Felder aktualisiert.

Eine Feldmaske zur Angabe der Mandantenfelder, die aktualisiert werden sollen. Es werden nur Felder der obersten Ebene von Tenant unterstützt.

Eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Tenant.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie in der Authentifizierungsübersicht.