HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

La demande groupée que les clients utilisent pour envoyer une collection potentiellement importante d'opérations sur les ressources en une seule demande. Pour un PUT, PATCH ou POST, les données de l'opération sont les données de ressources comme pour une requête SCIM unique.

post
https://{tenanturl}/v2.0/Bulk

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 manageUsers (Gérer tous les utilisateurs), ou manageUsersInStandardGroups (Gérer les utilisateurs dans 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).
Note : Vous n'avez besoin que d'un seul droit, mais vous pouvez en avoir plusieurs.

Le nombre maximal d'opérations est de 1000 et la taille maximale de la charge utile est de 1048576.

Par défaut, un courriel est envoyé aux utilisateurs qui sont créés, modifiés, supprimés, et ajoutés ou supprimés en tant que membres d'un groupe. Les modèles d'e-mail pour le branding se trouvent dans "notifications/user_management/profile/" et "notifications/user_management/group/".
Passez le paramètre de requête themeId pour marquer le modèle d'e-mail pour les notifications.
Pour désactiver les notifications par courrier électronique, envoyez notifyType=NONE en tant que paramètre de requête.

Exemple de charge utile d'une requête groupée :

{ "schemas" :[ "urn:ietf:params:scim:api:messages:2.0:BulkRequest" ], "Operations" :[ { "method" : "POST", "bulkId":"qwerty0", "path" : "/Users", "data":{ "schemas" :[" urn:ietf:params:scim:schemas:core:2.0:User "], "userName":"tim_mo", "emails" :[ { "type":"work", "value":"[email protected]" } ] } }, { "method" : "POST", "path" : "/Users", "data":{ "schemas" :[" "], "emails" :[ ] } }, { "method" : "POST", "bulkId":"qwerty1", "path" : "/Users", "data":{ "schemas" :[" urn:ietf:params:scim:schemas:core:2.0:User "," urn:ietf:params:scim:schemas:extension:ibm:2.0:User "], "userName":"bulkUser2@www. realm.com ", " urn:ietf:params:scim:schemas:extension:ibm:2.0:User " : { "userCategory":"federated" } } }, { "method" : "POST", "path" : "/Groups", "bulkId":"qwerty2", "data" : {"schemas" :[" urn:ietf:params:scim:schemas:core:2.0:Group "], "displayName":"mygroup", "members" :[ {"type":"user", "value":"bulkId:qwerty0"}, {"type":"user", "value":"bulkId:qwerty1"}, {"type":"user", "value":"501X123JRS"} ] } } }, { "method":"DELETE", "path":"/Users/500EPPJQCS" } ]}

Query Params
string
enum

Paramètre de requête facultatif indiquant le type de notification. S'il n'est pas présent, la notification EMAIL est utilisée. Spécifiez NONE si aucune notification à l'utilisateur n'est requise.

Allowed:
string

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

Body Params

La charge utile de la demande groupée.

schemas
array of strings
required

Un tableau de chaînes contenant les URI indiquant les espaces de noms des schémas SCIM qui définissent les attributs dans la structure JSON actuelle. L'URI du schéma doit être "urn:ietf:params:scim:api:messages:2.0:BulkRequest" comme l'exige la spécification SCIM.

schemas*
int32

Un nombre entier qui spécifie le nombre d'erreurs que le fournisseur de services accepte avant que l'opération ne soit terminée et qu'une réponse d'erreur ne soit renvoyée.

Operations
array of objects
required

Définit les opérations d'un travail en masse. Chaque opération correspond à une seule demande HTTP contre un point de terminaison de la ressource.

Operations*
Headers
string
enum
Defaults to false

Si la valeur est "true", l'utilisateur n'est pas tenu de modifier son mot de passe après s'être connecté.
N'est honoré que si le mot de passe de l'utilisateur est fourni dans la demande groupée.

Allowed:
Responses

Updated 9 months ago

Language
URL
Response 
 Choose an example:
application/scim+json
Updated 9 months ago