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 .
Pour créer un nouveau groupe d'utilisateurs, utilisez le point de terminaison
POST {baseURL}/v3/usergroups
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 .
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 existant à un groupe d'utilisateurs existant, utilisez le point de terminaison
POST {baseURL}/v3/usergroups/{userGroupId}/users
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
Pour ajouter des utilisateurs à un groupe d'utilisateurs Server, indiquez les paramètres suivants :
userGroupId (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs auquel vous souhaitez ajouter des utilisateurs.
userIds (corps) : obligatoire. Saisissez la liste des ID d'utilisateurs à ajouter à ce groupe d'utilisateurs, séparés par des virgules.
Pour ajouter un groupe Active Directory à un groupe d'utilisateurs existant, utilisez le point de terminaison
POST /v3/usergroups/{userGroupId}/activedirectorygroups
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
Ce point de terminaison ne peut être utilisé que pour les instances de Server configurées pour l'authentification Windows.
userGroupId (chaîne) : obligatoire. Saisissez l'ID d'un groupe d'utilisateurs existant auquel vous souhaitez ajouter un groupe Active Directory.
sid (chaîne) : obligatoire. Saisissez l'identifiant de sécurité (SID) du groupe Active Directory. Il s'agit d'une charge utile de corps en JSON. Vous devez soumettre la valeur entre guillemets, par exemple “S-My-SID”.
Pour récupérer tous les enregistrements de groupes d'utilisateurs accessibles, utilisez le point de terminaison
GET {baseURL}/v3/usergroups
. Filtrez avec plusieurs paramètres pour rechercher les utilisateurs.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 détails sur un groupe d'utilisateurs existant, utilisez le point de terminaison
GET {baseURL}/v3/usergroups/{userGroupId}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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.
userGroupId (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs existant 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/{userGroupId}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
userGroupId (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 existant, utilisez le point de terminaison
DELETE {baseURL}/v3/usergroups/{userGroupId}/users/{userId}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
Si l'utilisateur ne fait pas partie du groupe d'utilisateurs, 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 retirer un groupe Active Directory d'un groupe d'utilisateurs existant, utilisez le point de terminaison
DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
Ce point de terminaison ne peut être utilisé que pour les instances de Server configurées pour l'authentification Windows.
userGroupId (chaîne) : obligatoire. Saisissez l'identifiant du groupe d'utilisateurs 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.
Pour supprimer un groupe d'utilisateurs existant du système, utilisez le point de terminaison
DELETE {baseURL}/v3/usergroups/{userGroupId}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 ».
userGroupId (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 des autorisations de 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 .