Skip to main content

Points de terminaison du groupe d'utilisateurs

Points de terminaison et paramètres de groupes d'utilisateurs Server

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 d'utilisateurs Server, consultez la page d'aide Gestion des utilisateurs et des groupes .

Créer un nouveau groupe d'utilisateurs Server

Pour créer un groupe d'utilisateurs Server, utilisez le point de terminaison POST {baseURL}/v3/usergroups .

Paramètres

Pour créer un groupe d'utilisateurs Server, indiquez le paramètre « contract » :

  • contract (corps) : obligatoire. Indiquez les paramètres suivants pour un groupe d'utilisateurs Server :

    • name (string) : obligatoire. Saisissez un nom de groupe d'utilisateurs Server.

    • role (chaîne) : obligatoire. Saisissez un rôle pour ce groupe d'utilisateurs Server. 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 .

Exemple de demande : cURL

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'

Ajouter un utilisateur à un groupe d'utilisateurs Server

Pour ajouter au moins un utilisateur à un groupe d'utilisateurs Server, utilisez le point de terminaison POST {baseURL}/v3/usergroups/{id}/users .

Paramètres

Pour ajouter des utilisateurs à un groupe d'utilisateurs Server, indiquez les paramètres suivants :

  • id (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs Server auquel vous souhaitez ajouter des utilisateurs.

  • userIds (corps) : obligatoire. Saisissez les ID d'utilisateurs que vous souhaitez ajouter à ce groupe d'utilisateurs Server.

Ajouter un groupe Active Directory comme membre d'un groupe d'utilisateurs Server.

Pour ajouter un groupe Active Directory comme membre d'un groupe d'utilisateurs Server, utilisez le point de terminaison POST /v3/usergroups/{id}/activedirectorygroups .

Note

Ce point de terminaison ne peut être utilisé que pour les instances de Server configurées pour l'authentification Windows.

Paramètres

  • id (chaîne) : obligatoire. Saisissez l'ID d'un groupe d'utilisateurs Server existant auquel vous souhaitez ajouter un groupe Active Directory.

  • sid (chaîne) : obligatoire. Saisissez l'identifiant de sécurité (SID) du groupe Active Directory. Vous devez soumettre la valeur entre guillemets, par exemple “S-My-SID”.

Récupérer tous les groupes d'utilisateurs Server

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 Server seront récupérés. Aucun groupe Active Directory ne sera renvoyé.

Paramètres

Aucun paramètre requis.

Exemple de demande : cURL

curl --location --request GET 'http://localhost/webapi/v3/usergroups' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Rechercher un groupe d'utilisateurs Server spécifique

Pour récupérer des informations sur un groupe d'utilisateurs Server spécifique, utilisez le point de terminaison GET {baseURL}/v3/usergroups/{id} .

Note

Fonctionne uniquement pour les groupes d'utilisateurs Server. Les groupes Active Directory ne peuvent pas être récupérés à partir de ce point de terminaison.

Paramètres

  • id (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs Server pour récupérer des informations sur ce groupe d'utilisateurs.

Exemple de demande : cURL

curl --location --request GET 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Mettre à jour un groupe d'utilisateurs Server

Pour mettre à jour le nom et le rôle d'un groupe d'utilisateurs Server existant, utilisez le point de terminaison PUT {baseURL}/v3/usergroups/{id} .

Paramètres

  • id (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs Server pour mettre ce groupe à jour.

  • contract (corps) : obligatoire. Pour mettre à jour un groupe d'utilisateurs Server, le paramètre « contract » est obligatoire. Indiquez les éléments suivants :

    • name (chaîne) : obligatoire. Saisissez un nom de groupe d'utilisateurs Server.

    • 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 .

Exemple de demande : cURL

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'

Retirer un utilisateur d'un groupe d'utilisateurs Server

Pour retirer un utilisateur spécifique d'un groupe d'utilisateurs Server, 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.

Paramètres

  • userGroupId (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs Server dont vous souhaitez supprimer l'utilisateur.

  • userId (chaîne) : obligatoire. Saisissez l'ID d'utilisateur que vous souhaitez retirer du groupe d'utilisateurs Server.

Exemple de demande : cURL

curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069/users/61d564361d6d5da7ad461a32' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Retirer un groupe Active Directory de la liste des membres d'un groupe d'utilisateurs Server.

Pour retirer un groupe Active Directory de la liste des membres d'un groupe d'utilisateurs Server, utilisez le point de terminaison DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid} .

Note

Ce point de terminaison ne peut être utilisé que pour les instances de Server configurées pour l'authentification Windows.

Paramètres

  • userGroupId (chaîne) : obligatoire. Saisissez l'identifiant du groupe d'utilisateurs Server dont vous souhaitez retirer le groupe Active Directory.

  • adGroupSid (chaîne) : obligatoire. Saisissez l'identifiant de sécurité (SID) du groupe Active Directory que vous souhaitez retirer du groupe d'utilisateurs Server.

Supprimer un groupe d'utilisateurs Server

Pour supprimer un groupe d'utilisateurs Server 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 Server n'est pas vide et que le paramètre de requête « forceDelete » est défini sur « faux ».

Paramètres

  • id (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs Server à supprimer.

  • forceDelete (booléen) : facultatif. S'il est défini sur « vrai », le groupe d'utilisateurs Server sera supprimé même s'il contient des utilisateurs.

Exemple de demande : cURL

curl --location --request DELETE 'http://localhost/webapi/v3/usergroups/61d58ac83c15317e1a482069?forceDelete=true' \ --header 'Authorization: Bearer BearerTokenGoesHere'

Relations d'objets

Si vous créez un groupe d'utilisateurs Server, vous pouvez utiliser les objets créés comme suit :

Objet créé : «  id  » (par exemple, « id » : « 619158e57e607d0011ac3009 »)

Vous pouvez l'utiliser comme :

Exemples de demandes Postman

POST /v3/usergroups

Example of a POST request in Postman.

DELETE /v3/usergroups/{userGroupId}/users/{userId}

Example of a DELETE request in Postman.

Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman .

Dans cette section​: