Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets .
Pour plus d'informations sur les groupes personnalisés, consultez la page d'aide Gestion des utilisateurs et des groupes .
Pour créer un nouvel enregistrement de groupe d'utilisateurs, utilisez le point de terminaison
POST {baseURL}/v3/usergroups
.
Pour créer un nouveau groupe d'utilisateurs, indiquez le paramètre « contract » :
contract (corps) : obligatoire. Indiquez les paramètres suivants pour un groupe d'utilisateurs :
name (chaîne) : obligatoire. Saisissez un nom de groupe d'utilisateurs.
role (chaîne) : obligatoire. Saisissez un rôle pour ce groupe d'utilisateurs. Choisissez parmi ces options : NoAccess, Viewer, Member, Artisan, Curator et Evaluated. Le rôle par défaut (Evaluated) est évalué lors de l'exécution. Pour plus d'informations sur les rôles et les autorisations, consultez la page Rôles et autorisations des utilisateurs .
curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'
Pour ajouter au moins un utilisateur à un groupe d'utilisateurs, utilisez le point de terminaison
POST {baseURL}/v3/usergroups/{id}/users
.
Pour ajouter des utilisateurs à un groupe d'utilisateurs, indiquez les paramètres suivants :
id (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs auquel vous souhaitez ajouter des utilisateurs.
userIds (corps) : obligatoire. Saisissez les ID d'utilisateurs que vous souhaitez ajouter à ce groupe d'utilisateurs.
À ajouter.
Pour rechercher des utilisateurs, utilisez le point de terminaison
GET {baseURL}/v3/usergroups
. Filtrez avec plusieurs paramètres pour rechercher les utilisateurs.
Note
Seuls les groupes d'utilisateurs personnalisés seront récupérés. Aucun groupe Active Directory ne sera renvoyé.
Aucun paramètre requis.
curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Pour récupérer des informations sur un groupe d'utilisateurs spécifique, utilisez le point de terminaison
GET {baseURL}/v3/usergroups/{id}
.
Note
Fonctionne uniquement pour les groupes d'utilisateurs personnalisés. Les groupes Active Directory ne peuvent pas être récupérés à partir de ce point de terminaison.
id (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs pour récupérer des informations sur ce groupe d'utilisateurs.
curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Pour mettre à jour le nom et le rôle d'un groupe d'utilisateurs existant, utilisez le point de terminaison
PUT {baseURL}/v3/usergroups/{id}
.
id (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs pour mettre ce groupe à jour.
contract (corps) : obligatoire. Pour mettre à jour un groupe d'utilisateurs, le paramètre « contract » est obligatoire. Indiquez les éléments suivants :
name (chaîne) : obligatoire. Saisissez un nom de groupe d'utilisateurs.
role (chaîne) : obligatoire. Vous pouvez choisir parmi ces options : NoAccess, Viewer, Member, Artisan, Curator et Evaluated. Pour plus d'informations sur les rôles et les autorisations, consultez la page Rôles et autorisations des utilisateurs .
curl --location --request PUT 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Authorization: Bearer BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'
Pour retirer un utilisateur spécifique d'un groupe d'utilisateurs, utilisez le point de terminaison
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Note
Si l'utilisateur ne fait pas partie du groupe, une réponse OK est renvoyée.
userGroupId (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs dont vous souhaitez retirer l'utilisateur.
userId (chaîne) : obligatoire. Saisissez l'ID d'utilisateur que vous souhaitez retirer du groupe d'utilisateurs.
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Pour supprimer un groupe d'utilisateurs spécifique du système, utilisez le point de terminaison
DELETE {baseURL}/v3/usergroups/{id}
.
Note
Le message d'erreur « 400 : requête incorrecte » est renvoyé si le groupe d'utilisateurs n'est pas vide et que le paramètre de requête « forceDelete » est défini sur « faux ».
id (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs à supprimer.
forceDelete (booléen) : facultatif. S'il est défini sur « vrai », le groupe d'utilisateurs sera supprimé même s'il contient des utilisateurs.
curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Si vous créez un groupe d'utilisateurs, vous pouvez utiliser les objets créés comme suit :
Objet créé : « id » (par exemple, « id » : « 619158e57e607d0011ac3009 »)
Vous pouvez l'utiliser comme :
userGroupId si vous ajoutez un groupe d'utilisateurs à une collection .
userGroupId si vous mettez à jour les autorisations du groupe d'utilisateurs d'une collection .
userGroupId si vous retirez un groupe d'utilisateurs d'une collection .
userGroupId si vous souhaitez partager des informations d'identification avec un groupe d'utilisateurs .
userGroupId si vous souhaitez retirer un groupe d'utilisateurs d'informations d'identification .
userGroupId si vous souhaitez ajouter un groupe d'utilisateurs à une connexion aux données .
userGroupId si vous souhaitez retirer un groupe d'utilisateurs d'une connexion aux données .
POST /v3/usergroups
DELETE /v3/usergroups/{userGroupId}/users/{userId}
Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman .