REST Resource: customers.v2.Groups

Ressource : Group

Représentation SCIM d'un groupe.

Représentation JSON 
{
  "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)
  }
}
Champs
schemas[]

string

Obligatoire. Liste des URI qui indiquent les espaces de noms des schémas SCIM définissant les attributs présents dans la structure JSON actuelle. Ne doit contenir que les valeurs définies comme schema et schemaExtensions pour le ResourceType du groupe.
members[]

object (Member)

Facultatif. Liste des membres de ce groupe. Cet attribut n'est pas renvoyé pour le moment. Les abonnements à des groupes peuvent être modifiés à l'aide de requêtes PATCH.
id

string

Identifiant. Identifiant unique du groupe. Les caractéristiques de l'attribut sont caseExact en tant que true, une mutabilité de readOnly et une caractéristique returned de always.
externalId

string

Facultatif. Identifiant de la ressource tel que défini par le client de provisionnement.
meta

object (Meta)

Uniquement en sortie. Métadonnées de ressources. Tous les sous-attributs ont une mutabilité de readOnly et une caractéristique returned de default.
displayName

string

Obligatoire. Nom à afficher du groupe.
urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup

object (CloudIdentityGroupExtension)

Obligatoire. Attributs de groupe spécifiques à Cloud Identity.

Membre

Représentation SCIM d'un membre du groupe.

Représentation JSON 
{
  "value": string,
  "$ref": string
}
Champs
value

string

Immuable. Identifiant du membre de ce groupe.
$ref

string

Immuable. URI du membre.

CloudIdentityGroupExtension

Définit les attributs de l'extension Google Cloud Identity Group. L'URN du schéma pour cette extension est la suivante : urn:ietf:params:scim:schemas:extension:google:2.0:CloudIdentityGroup.

Représentation JSON 
{
  "email": string,
  "description": string
}
Champs
email

string

Obligatoire. Adresse e-mail du groupe. Si votre compte comporte plusieurs domaines, sélectionnez celui qui convient pour l'adresse e-mail. Le email doit être unique. Les adresses e-mail de groupe sont soumises aux mêmes règles d'utilisation des caractères que les noms d'utilisateur. Pour en savoir plus, consultez la documentation du Centre d'aide.
description

string

Facultatif. Description détaillée pour aider les utilisateurs à déterminer l'objectif d'un Group.

Limite : 4 096 caractères.

Méthodes

create

 Crée un groupe.

delete

 Supprime un groupe.

get

 Récupère un groupe.

list

 Récupère une liste de groupes.

patch

 Met à jour un groupe à l'aide de la sémantique de correctif SCIM.