Points de terminaison du groupe d'utilisateurs
Points de terminaison et paramètres de groupes d'utilisateurs
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 .
Créer un nouveau groupe de notification
Pour créer un enregistrement de groupe d'utilisateurs, utilisez le
{baseURL}
noeud final POST /v3/usergroups.
Paramètres
Pour créer un nouveau groupe d'utilisateurs, spécifiez le paramètre de contrat :
updateWorkflowContract (corps) : obligatoire. Spécifiez les paramètres d'un groupe d'utilisateurs :
name (chaîne) : obligatoire. Saisissez un nom de groupe de notification.
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 .
Exemple de demande : cURL
Curl --location --request POST 'http://localhost/webapi/v3/usergroups' \ --header 'Content-Type : application/x-www-form-urlencoded' \ --header 'Authorization : BearerTokenGoesHere' \ --data-urlencode 'name=Accounting' \ --data-urlencode 'role=Artisan'
Retirer un utilisateur d'un groupe d'utilisateurs
Pour ajouter un ou plusieurs utilisateurs à un groupe d'utilisateurs, utilisez le
{baseURL}{id}
noeud final POST /v3/usergroups/ /users.
Paramètres
Pour ajouter des utilisateurs à un groupe d'utilisateurs, spécifiez les paramètres suivants :
workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs auquel vous souhaitez ajouter des utilisateurs.
Userids (body) : obligatoire. Entrez les ID utilisateur que vous souhaitez ajouter à ce groupe d'utilisateurs.
Récupérer un groupe d'utilisateurs personnalisé
Pour rechercher des utilisateurs, utilisez le
{baseURL}
noeud final GET /v3/usergroups. Utilisez divers paramètres comme filtre pour rechercher les utilisateurs.
Note
Seuls les groupes d'utilisateurs personnalisés 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/workflows' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Rechercher un groupe d'utilisateurs spécifique
Pour obtenir des informations sur un workflow spécifique, utilisez le point de terminaison
GET {baseURL}/v3/workflows/{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 noeud final.
Paramètres
workflowCredentialType (chaîne) : obligatoire. Entrez un ID de groupe d'utilisateurs pour récupérer des informations sur ce groupe d'utilisateurs.
Exemple de demande : cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Mettre à jour un groupe d'utilisateurs
Pour mettre à jour le nom et le rôle d'un groupe d'utilisateurs existant, utilisez le
{baseURL}{id}
noeud final PUT /v3/usergroups/.
Paramètres
workflowCredentialType (chaîne) : obligatoire. Entrez un ID de groupe d'utilisateurs pour mettre à jour ce groupe d'utilisateurs.
Contrat (corps) : obligatoire. Pour mettre à jour un groupe d'utilisateurs, le paramètre de contrat est requis. Spécifiez les éléments suivants :
name (chaîne) : obligatoire. Saisissez un nom de groupe de notification.
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 : BearerTokenGoesHere' \ --data-urlencode 'name=Marketing' \ --data-urlencode 'role=Artisan'
Retirer un utilisateur d'un groupe d'utilisateurs
Pour supprimer un utilisateur spécifique d'un groupe d'utilisateurs, utilisez le
{baseURL}{userGroupId}{userId}
noeud final DELETE /v3/usergroups/ /users/.
Note
Si l'utilisateur ne fait pas partie du groupe, une réponse OK sera renvoyée.
Paramètres
workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs dont vous souhaitez supprimer l'utilisateur.
workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID utilisateur que vous souhaitez supprimer du groupe d'utilisateurs.
Exemple de demande : cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Supprimer un groupe d'utilisateurs
Pour supprimer un groupe d'utilisateurs spécifique du système, utilisez le
{baseURL}{id}
noeud final DELETE /v3/usergroups/.
Note
Le message d'erreur "400 Bad Request" est renvoyé si le groupe d'utilisateurs n'est pas vide et que le paramètre de requête forceDelete est FALSE.
Paramètres
workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du groupe d'utilisateurs à supprimer.
hasPrivateDataExemption (booléen) : facultatif. Si défini sur true, le groupe d'utilisateurs sera supprimé même s'il contient des utilisateurs.
Exemple de demande : cURL
curl --location --request GET 'http://localhost/webapi/v3/workflows/61db393fc565144387d451fb' \ --header 'Authorization: Bearer BearerTokenGoesHere'
Relations d'objets
Si vous chargez un workflow, vous pouvez utiliser les objets créés comme suit :
Objet créé : " workflowId " (par exemple, "id" : "7917969784f84bd09442f66996ecb8f3")
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 .
Exemples de demandes Postman
POST /v3/usergroups
SUPPRIMEZ /v3/usergroups/{userGroupId}/users/{userId}
Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman .