Cette API est utilisée pour modifier les attributs d'un groupe. Il peut être utilisé pour mettre à jour un ou plusieurs attributs.

Intitulé requis : manageUserGroups (Gérer les utilisateurs et les groupes), ou manageAllUserGroups (Synchroniser les utilisateurs et les groupes), ou manageUserStandardGroups (Gérer les utilisateurs et les groupes standard), ou manageGroups (Gérer tous les groupes mais pas leurs membres), ou manageStandardGroups (Gérer les groupes standard mais pas leurs membres), ou manageGroupMembers (Gérer tous les groupes et leurs membres), ou manageStandardGroupMembers (Gérer les groupes standard et leurs membres), ou updateAnyGroupMember (Gérer l'appartenance à des groupes).
Remarque : vous n'avez besoin que d'un seul droit, mais vous pouvez en avoir plusieurs.

Restrictions par demande : Jusqu'à 1 000 opérations de patch sont autorisées. Le nombre total de "valeurs" spécifiées ne peut pas dépasser 1 000.

Limitations : Si le groupe à corriger compte plus de 9 000 membres, l'opération "replace" sur l'attribut "members" n'est pas prise en charge et seul l'opérateur "eq" est autorisé dans le filtre de sélection.

Par défaut, un courrier électronique est envoyé à chaque membre utilisateur régulier ajouté et supprimé du groupe. Les membres utilisateurs fédérés ne reçoivent pas de notification par courriel. Les modèles de courrier électronique pour la stratégie de marque se trouvent à "notifications/user_management/group/ {locale}/user_added_to_group_email.xml " et "notifications/user_management/group/ {locale}/user_removed_from_group_email.xml ". Passez le paramètre de requête themeId pour marquer les modèles d'e-mail pour les notifications.

L'exemple suivant est une demande de correctif pour remplacer le groupe displayName, supprimer un membre, et ajouter de nouveaux membres. Notez également que l'exemple montre comment vous pouvez spécifier le site notifyType si vous le souhaitez.
NotifyType est un attribut facultatif qui indique le type de notification. Si elle n'est pas présente, la notification EMAIL est used.Specify NONE si aucune notification aux utilisateurs concernés n'est requise.

{ "schemas" :[ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations" : [ { "op": "replace", "path": "displayName", "value": "New Group Name" }, { "op": "remove", "path": "members[value eq "50JFP28VS4"]" }, {"op" : "add", "path" : "members", "value" : [ { "type": "user", "value": "50RJ493GRW" }, { "type": "user", "value": "50G6E672MU" } ] }, { "op": "add", "path": "urn:ietf:params:scim:schemas:extension:ibm:2.0:Notification:notifyType", "value": "EMAIL" } ]}

Path Params
string
required

L'ID du groupe à patcher.

Query Params
string

L'identifiant du thème que vous souhaitez appliquer.

Body Params

L'organe de l'opération patch du groupe.

schemas
array of strings
required

Le corps de chaque demande SCIM PATCH doit contenir l'attribut "schemas" avec la valeur URI : "urn:ietf:params:scim:api:messages:2.0:PatchOp".

schemas*
Operations
array of objects
required

Un tableau d'objets d'opérations à effectuer. Les objets d'opération doivent avoir exactement un membre "op", dont la valeur indique l'opération à effectuer. Sa valeur doit être l'une des suivantes : "ajouter", "supprimer" ou "remplacer". Les valeurs sont des erreurs.

Operations*
Responses
204

Aucun contenu.

Language
URL
Response
Choose an example:
application/scim+json