REST Resource: customers.v2.Groups

Ressource : Groupe

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 d'URI indiquant les espaces de noms des schémas SCIM qui définissent les attributs présents dans la structure JSON actuelle. Ne doit contenir que des valeurs définies comme schema et schemaExtensions pour le type de ressource Group.

members[]

object (Member)

Facultatif. Liste des membres de ce groupe. Cet attribut n'est actuellement pas renvoyé. Les abonnements à des groupes peuvent être modifiés via des requêtes PATCH.

id

string

Identifiant. ID unique du groupe. Les caractéristiques de l'attribut sont caseExact défini sur 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 de 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 de groupe Google Cloud Identity. L'URN de 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 le domaine approprié pour l'adresse e-mail. L'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 permettant aux utilisateurs de 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.