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 Ressourcentyp „Gruppe“ 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 Attributeigenschaften sind caseExact als true, eine Veränderbarkeit von readOnly und eine returned-Eigenschaft von always.
externalId

string

Optional. Eine ID für die Ressource, wie sie vom Bereitstellungsclient definiert wird.
meta

object (Meta)

Nur Ausgabe. Ressourcenmetadaten. Alle Unterattribute haben eine Veränderbarkeit 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. Gruppenattribute, die spezifisch für Cloud Identity sind.

Mitglied

SCIM-Darstellung eines Gruppenmitglieds.

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

string

Nicht veränderbar. ID 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-Gruppenerweiterung. Der Schema-URN für diese Erweiterung ist 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 entsprechende Domain für die E-Mail-Adresse aus. Die email muss eindeutig sein. Für E-Mail-Adressen von Gruppen gelten dieselben Regeln für die Verwendung von Zeichen wie für Nutzernamen. Weitere Informationen finden Sie in der Hilfe.
description

string

Optional. Eine ausführliche Beschreibung, mit der Nutzer den Zweck einer Group bestimmen können.

Maximale Länge: 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 der SCIM-Patch-Semantik.