Skip to main content

Points de terminaison de l'utilisateur

Points de terminaison et paramètres d'utilisateurs

Pour en savoir plus sur les relations d'objets, accéder à #relations-d-objets-6518518 la section relations d'objet.

Pour plus d'informations sur les utilisateurs, consultez la page d'aide Gestion des utilisateurs et des groupes.

Créer un utilisateur

Pour créer un enregistrement d'utilisateur, utilisez le {baseURL} noeud final POST /v3/users.

Note

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

Paramètres

  • UserContract (body) : pour créer un nouvel utilisateur, le paramètre userContract est requis. Indiquez les paramètres de temps de trajet suivants.

    • workflowCredentialType (chaîne) : obligatoire. Entrez le prénom d'un utilisateur.

    • workflowCredentialType (chaîne) : obligatoire. Entrez le nom de famille d'un utilisateur.

    • workflowCredentialType (chaîne) : obligatoire. Saisissez l'adresse e-mail d'un utilisateur.

    • role (chaîne) : facultatif. Vous pouvez choisir parmi ces options : NoAccess, Viewer, Member, Artisan, Curator et Evaluated (rôle par défaut évalué à l'exécution). Pour plus d'informations sur les rôles et les autorisations, consultez la page Rôles et autorisations des utilisateurs. Lorsqu'aucun rôle n'est sélectionné, le rôle Evaluated est utilisé par défaut.

    • defaultWorkerTag (chaîne) : facultatif. Indiquez la balise worker définie dans les workers pour attribuer des tâches à certains nœuds worker. Si elle n'est pas précisée, la valeur par défaut est définie sur "". Pour plus d'informations, consultez la page d'aide Worker.

    • canScheduleJobs (booléen) : facultatif. Indiquez si l'utilisateur peut planifier des tâches. Lorsque cela n'est pas précisé, la valeur par défaut est définie sur « faux ». Pour plus d'informations, consultez la page d'aide Tâches.

    • canPrioritizeJobs (booléen) : facultatif. Indiquez si un utilisateur peut hiérarchiser des tâches. Lorsque cela n'est pas précisé, la valeur par défaut est définie sur « faux ». Pour plus d'informations, consultez la page d'aide Tâches.

    • canAssignJobs (booléen) : facultatif. Indiquez si un utilisateur peut affecter des tâches. Lorsque cela n'est pas précisé, la valeur par défaut est définie sur « faux ». Pour plus d'informations, consultez la page d'aide Tâches.

    • canCreateCollections (booléen) : facultatif. Indiquez si un utilisateur peut créer de nouvelles collections. Lorsque cela n'est pas précisé, la valeur par défaut est définie sur « faux ». Pour plus d'informations, consultez la page d'aide Collections.

    • isPublic (booléen) : facultatif. Spécifiez si l'API est activée pour un utilisateur. Lorsque cette option n'est pas sélectionnée, la valeur par défaut est « false ».

    • credentialId (chaîne) : facultatif. Ce paramètre fait référence à l'ID unique d'un Workflow, attribué par défaut à l'utilisateur. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.

    • force (booléen) : facultatif. Sélectionnez si un utilisateur est actif ou désactivé. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.

    • direction (chaîne) : facultatif. Saisissez le fuseau horaire, par exemple Europe/Kiev. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.

Exemple de demande : cURL

Curl --location --request POST 'http://localhost/webapi/v3/users' \ --header 'Content-Type : application/x-www-form-urlencoded' \ --header 'Authorization : BearerTokenGoesHere' \ --data-urlencode 'FirstName=John' \ --data-urlencode 'lastName=Doe' \ --data-urlencode 'email=John.Doe@emailexample.com'

Désactiver un utilisateur

Pour désactiver un utilisateur dans le système, utilisez le {baseURL}{id} noeud final POST /v3/users/ /deactivate.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur pour désactiver cet utilisateur.

Exemple de demande : cURL

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

Réinitialiser un mot de passe pour un utilisateur

Pour réinitialiser et envoyer un e-mail de réinitialisation de mot de passe pour un utilisateur spécifique, utilisez le {baseURL}{id}noeud final POST /v3/users/ /passwordReset.

Note

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

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur pour réinitialiser son mot de passe.

Exemple de demande : cURL

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

Rechercher des utilisateurs

Pour rechercher des utilisateurs, utilisez le {baseURL} noeud final GET /v3/users. Utilisez divers paramètres comme filtre pour rechercher les utilisateurs.

Paramètres

  • view (chaîne) : facultatif. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « Default » et « Full ». Si ce paramètre est défini sur « Default », un objet de vue réduite est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.

  • force (booléen) : facultatif. Sélectionnez si un utilisateur est actif ou désactivé.

  • limit (chaîne) : facultatif. Saisissez l'adresse e-mail de l'utilisateur.

  • role (chaîne) : facultatif. Sélectionnez le rôle d'utilisateur pour affiner la recherche. 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.

  • limit (chaîne) : facultatif. Saisissez le prénom de l'utilisateur.

  • limit (chaîne) : facultatif. Entrez le nom de famille de l'utilisateur.

  • CreatedAfter (date-heure) : facultatif. Saisissez la date et l'heure après laquelle le workflow a été créé. Saisissez la date et l'heure au format ISO8601.

  • CreatedBefore (date-heure) : facultatif. Saisissez la date et l'heure avant laquelle le workflow a été créé. Saisissez la date et l'heure au format ISO8601.

Exemple de demande : cURL

Curl --location --request GET 'http://localhost/webapi/v3/users?view=Full&active=true&lastName=Doe' \ --header 'Authorization : BearerTokenGoesHere'

Rechercher un utilisateur

Pour rechercher un utilisateur spécifique, utilisez le{baseURL}{id} noeud final GET /v3/users/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur pour récupérer des informations sur cet utilisateur.

Exemple de demande : cURL

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

Récupérer toutes les ressources dont un utilisateur est propriétaire

Pour obtenir la liste complète des actifs détenus par un utilisateur, utilisez le {baseURL}{id} point de terminaison GET /v3/users/ /assets.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur pour récupérer la liste des ressources de cet utilisateur.

  • offset (chaîne) : facultatif. Sélectionnez les types de biens que vous souhaitez renvoyer. La valeur par défaut est 'All'.

Exemple de demande : cURL

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

Mettre à jour un utilisateur existant

Pour mettre à jour un utilisateur existant, utilisez le{baseURL}{id} noeud final PUT /v3/users/.

Note

L'ID du updateContract sera écrasé par la valeur ID dans l'URL.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur pour mettre à jour cet utilisateur.

  • updateWorkflowContract (corps) : obligatoire. Pour mettre à jour un utilisateur, le paramètre updateContract est requis. Spécifiez les éléments suivants :

    • limit (chaîne) : facultatif. Saisissez un ID utilisateur pour le mettre à jour.

    • workflowCredentialType (chaîne) : obligatoire. Entrez le prénom d'un utilisateur.

    • workflowCredentialType (chaîne) : obligatoire. Entrez le nom de famille d'un utilisateur.

    • workflowCredentialType (chaîne) : obligatoire. Saisissez l'adresse e-mail d'un utilisateur.

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

    • defaultWorkerTag (chaîne) : obligatoire. Indiquez la balise worker définie dans les workers pour attribuer des tâches à certains nœuds worker. Pour plus d'informations à propos des workers, consultez la page d'aide Worker.

    • canScheduleJobs (booléen) : obligatoire. Indiquez si un utilisateur peut planifier des tâches. Pour plus d'informations, consultez la page d'aide Tâches.

    • canPrioritizeJobs (booléen) : obligatoire. Indiquez si un utilisateur peut hiérarchiser des tâches. Pour plus d'informations, consultez la page d'aide Tâches.

    • canAssignJobs (booléen) : obligatoire. Indiquez si un utilisateur peut affecter des tâches. Pour plus d'informations, consultez la page d'aide Tâches.

    • canCreateCollections (booléen) : facultatif. Indiquez si un utilisateur peut créer des collections. Lorsqu'elle n'est pas spécifiée, la valeur reste la même qu'avant. Pour plus d'informations, consultez la page d'aide Collections.

    • makePublished (booléen) : obligatoire. Spécifiez si l'API est activée pour un utilisateur.

    • workflowCredentialType (chaîne) : obligatoire. Ce paramètre fait référence à l'ID unique d'un Workflow, attribué par défaut à l'utilisateur.

    • makePublished (booléen) : obligatoire. Indiquez si vous souhaitez verrouiller ce compte utilisateur.

    • makePublished (booléen) : obligatoire. Sélectionnez si un utilisateur est actif ou désactivé.

    • makePublished (booléen) : obligatoire. Spécifiez si l'adresse e-mail d'un utilisateur est validée.

    • name (chaîne) : obligatoire. Saisissez le fuseau horaire, par exemple Europe/Kiev, etc

    • workflowCredentialType (chaîne) : obligatoire. Les valeurs de langue prises en charge sont « de-de », « en-US », « es-es », « fr-fr », « it-it », "ja-jp", "pt-br", "zh-cn".

Exemple de demande : cURL

Curl --location --request PUT 'http://localhost/webapi/v3/users/61d564361d6d5da7ad461a32' \ --header 'Content-Type : application/x-www-form-urlencoded' \ --header 'Authorization : BearerTokenGoesHere' \ --data-urlencode 'FirstName=Doe' \ jdoe@alteryx.com - --data-urlencode 'lastName=Jane' \ - - Jobs-defurlendercanivel \ - True \ - Tag \ - True \ - Code-worker Data-urlencode 'canAssignJobs=true' \ --data-urlencode 'canCreateCollections=true' \ --data-urlencode 'isApiEnabled=true' \ --data-urlencode 'defaultCredentialId=jdoe' \ --data-urlenid36d36d36\ Prague \ zone 'code-idem-rud'=code 'code'=code-6ed'=

Supprimer l'utilisateur

Pour supprimer un utilisateur spécifique du système, utilisez le {baseURL}{id} noeud final DELETE /v3/users/.

Note

Si des actifs (workflows, plannings, collections, aperçus) ou des groupes d’utilisateurs sont affectés à l’utilisateur que vous souhaitez supprimer, cet utilisateur ne peut pas être supprimé.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID utilisateur à supprimer.

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 :

Exemples de demandes Postman

OBTENEZ /v3/users

Example of the GET request in Postman.

RÉCUPÉREZ /v3/users/{id}/assets

Example of the GET request in Postman.

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

Dans cette section​: