REST Resource: customers.v2.Groups

Ressource: Gruppe

SCIM-Darstellung einer Gruppe.

JSON-Darstellung 
{
  "schemas": [
    string
  ],
  "members": [
    {
      object (Member)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "displayName": string,
  "urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup": {
    object (CloudIdentityGroupExtension)
  }
}
Felder
schemas[]

string

Erforderlich. Eine Liste von URIs, die die Namespaces der SCIM-Schemas angeben, die die Attribute in der aktuellen JSON-Struktur definieren. Darf nur Werte enthalten, die als schema und schemaExtensions für den Group ResourceType definiert sind.
members[]

object (Member)

Optional. Die Liste der Mitglieder in dieser Gruppe. Dieses Attribut wird derzeit nicht zurückgegeben. Gruppenmitgliedschaften können über PATCH-Anfragen geändert werden.
id

string

ID. Die eindeutige ID für die Gruppe. Die Attributmerkmale sind caseExact als true, eine Unveränderlichkeit von readOnly und ein returned-Merkmal von always.
externalId

string

Optional. Eine Kennung für die Ressource, wie vom Bereitstellungsclient definiert.
meta

object (Meta)

Nur Ausgabe. Ressourcenmetadaten Alle Unterattribute haben eine Unveränderlichkeit von readOnly und eine returned-Eigenschaft von default.
displayName

string

Erforderlich. Der Anzeigename der Gruppe.
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup

object (CloudIdentityGroupExtension)

Erforderlich. Cloud Identity-spezifische Gruppenattribute.

Mitglied

SCIM-Darstellung eines Gruppenmitglieds.

JSON-Darstellung 
{
  "value": string,
  "$ref": string
}
Felder
value

string

Nicht veränderbar. Kennung des Mitglieds dieser Gruppe.
$ref

string

Nicht veränderbar. Der URI für das Mitglied.

CloudIdentityGroupExtension

Definiert die Attribute für die Google Cloud Identity Group-Erweiterung. Der Schema-URN für diese Erweiterung lautet: urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup.

JSON-Darstellung 
{
  "email": string,
  "description": string
}
Felder
email

string

Erforderlich. Die E-Mail-Adresse der Gruppe. Wenn Ihr Konto mehrere Domains hat, wählen Sie die gewünschte Domain für die E-Mail-Adresse aus. Die email muss eindeutig sein. Für Gruppen-E-Mail-Adressen gelten dieselben Regeln für die Verwendung von Zeichen wie für Nutzernamen. Weitere Informationen finden Sie in der Hilfedokumentation.
description

string

Optional. Eine ausführliche Beschreibung, die Nutzern hilft, den Zweck von Group zu ermitteln.

Höchstens 4.096 Zeichen.

Methoden

create

 Erstellt eine Gruppe.

delete

 Löscht eine Gruppe.

get

 Ruft eine Gruppe ab.

list

 Ruft eine Liste von Gruppen ab.

patch

 Aktualisiert eine Gruppe mit SCIM-Patch-Semantik.