exportUsers
Catégorie
| Metadata retrieval |
Description
| Renvoie les métadonnées de la liste complète de tous les utilisateurs de l'instance. |
Autorisations requises pour appeler
| Administrateur utilisateur |
Paramètres obligatoires à la demande
| Identifiants |
La demande de ce mode contient uniquement un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. Une fois vérifiée, la méthode renvoie un document XML décrivant l'ensemble complet de tous les utilisateurs définis dans l'instance.
Format de demande
<?xml version='1.0' encoding='UTF-8'?> <call method="exportUsers" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </call>
élément identifiants
| |||
Nom du marqueur
| identifiants | ||
Description
| Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
se connecter | O | Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode. | sampleuser@company.com |
mot de passe | O | Mot de passe de l'utilisateur appelant la méthode API. | my_password |
paramètres régionaux | N | Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée. | fr_FR |
instanceCode | N | Si l'utilisateur spécifié dans les identifiants a accès à plusieurs instances de : Adaptive Planning , cet attribut peut être utilisé pour indiquer que l'utilisateur a l'intention d'accéder à une instance autre que son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances. | MYINSTANCE1 |
Contenu de l'élément
| |||
(aucun) | |||
inclure l'élément Disponible dans API v17 et antérieures. Non disponible dans API v18 et supérieure. | |||
Nom du marqueur
| inclure | ||
Description
| Représente un ensemble d'indicateurs indiquant les aspects de l'information des utilisateurs qui doivent être inclus ou exclus de la réponse. Cet élément est facultatif : s'il n'est pas présent, les valeurs par défaut sont true (vrai) pour les périmètres de gestion et false pour masquer les versions. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
groupe(s) Disponible dans API v23 et supérieure. | N | Le mot Vrai ou Faux. Indique si les éléments utilisateur de la réponse incluent un attribut groupIds. Si true (vrai), groupIds de la réponse contient une liste de tous les groupes auxquels appartient l'utilisateur, séparés par des virgules. Si l'attribut n'est pas présent ou si sa valeur est différente de true ou false, la valeur par défaut false est utilisée. | vrai |
gestion des périmètres Disponible dans API v17 et antérieures. Non disponible dans API v18 et supérieure. | N | Le mot Vrai ou Faux. Indique si les éléments utilisateur de la réponse doivent inclure ou non des attributs allowedLevels. Si l'attribut n'est pas présent ou si sa valeur est différente de true ou false, la valeur par défaut true est utilisée. | vrai |
hiddenVersions Disponible dans API v17 et antérieures. Non disponible dans API v18 et supérieure. | N | Le mot Vrai ou Faux. Indique si les éléments utilisateur de la réponse doivent inclure ou non des attributs de version masquée. Si l'attribut n'est pas présent ou si sa valeur est différente de true ou false, la valeur par défaut false est utilisée. | false |
Contenu de l'élément
| |||
(aucun) | |||
Format de la réponse
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <users seqNo="55"> <user id="19" guid="B9ADBCB81AA2F9BAE040307F02092C2E" login="analytica@fakecompany.com" email="analytica@fakecompany.com" name="Anna Analyzer" permissionSetId="3" timeZone="US/Pacific"/> <user id="123" guid="AAFF5218D55ABB9234660001BEC117A9" login="randomuser@fakecompany.com" email="randomuser@fakecompany.com" name="J. Random User" permissionSetId="2" timeZone="US/Pacific"/> </users> </output> </response>
élément de réponse
| |||
Nom du marqueur
| réponse | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
réussite | O | Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse. | vrai |
obsolète | N | S'il figure sur le marqueur de réponse et qu'il est défini sur true (vrai), cet attribut indique que la version de la méthode ou de l'API en cours d'appel est obsolète et qu'elle est officielement dépréciée. Même si elle continue de fonctionner à ce moment, elle peut cesser de fonctionner prochainement. En général, cet attribut n'est pas présent. | false |
Contenu de l'élément
| |||
Un seul élément de messages facultatifs et exactement un élément de sortie obligatoire. | |||
élément de sortie
| |
Nom du marqueur
| sortie |
Attributs de l'élément
| |
(aucun) | |
Contenu de l'élément
| |
Un seul élément comptes. Ce filtre de sortie est standard sur toutes les réponses d'API et contient la sortie valide de tout appel d'API réussi. | |
élément users
| |||
Nom du marqueur
| utilisateur(s) | ||
Description
| Conteneur pour un ou plusieurs éléments utilisateur. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
seqNo Ajouté dans l'API v17, mais réservé pour une utilisation future. | |||
Contenu de l'élément
| |||
Un ou plusieurs éléments utilisateur. | |||
élément utilisateur
| |||
Nom du marqueur
| utilisateur | ||
Description
| Représente un seul utilisateur renvoyé en réponse à un appel d'API exportUsers. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
id | O | L'identifiant système interne de l'utilisateur. | 19 |
guide | O | Identifiant global unique pour l'utilisateur. Cet identifiant ne changera jamais pour cet utilisateur, même si son nom d'utilisateur ou son nom d'utilisateur change à l'avenir. | B9ADBCB81AA2F9BAE040307F02092C2E |
se connecter | O | L'identifiant de connexion de cet utilisateur. | analytica@fakecompany.com |
e-mail | O | L'adresse e-mail de cet utilisateur. Peut être vide si l'utilisateur n'a pas configuré d'adresse e-mail valide. | analytica@fakecompany.com |
nom | O | Le nom de cet utilisateur. | Anna Analyzer |
position
Disponible dans API v39 et supérieure | N | Poste de l'utilisateur. | "CEO" |
permissionSetId Disponible dans API v25 et supérieure Non disponible dans API v36 et supérieure | O | Identifiant système interne de l'ensemble d'autorisations attribué à cet utilisateur. Voir également exportPermissionSets. | |
permissionSetIds
Disponible dans API v36 et supérieure | O | Les identifiants du système interne des ensembles d'autorisations attribués à cet utilisateur. Voir également exportPermissionSets. | |
roleId Disponible dans API v25 et antérieures Non disponible dans API v25 et supérieure | O | Identifiant système interne du rôle affecté à cet utilisateur. Voir également exportRoles. | 3 |
gestion des périmètres Non disponible dans API v18 | O | Cet attribut est uniquement inclus si l'utilisateur inclus dans les identifiants de la demande dispose d'une autorisation d'administrateur de périmètre sur l'ensemble de l'arborescence de l'organisation et que la demande indique que les périmètres détenus doivent être inclus. S'il est inclus, la valeur de cet attribut est une liste des identifiants système internes des périmètres de l'organisation auxquels cet utilisateur a accès directement. L'utilisateur aura également accès à tous les périmètres enfants des périmètres répertoriés ici. | 5,10,13 |
hiddenVersions Non disponible dans API v18 | N (voir la description) | Cet attribut est uniquement inclus si l'utilisateur inclus dans les identifiants de la demande dispose de l'autorisation Administrateur de la version et que la demande indique que l'option emptyVersions doit être incluse. S'il est inclus, la valeur de cet attribut est une liste séparée par des virgules des identifiants système internes pour les versions ou les dossiers de version qui sont masqués pour cet utilisateur (mais dont le parent est inexistant ou non masqué). L'utilisateur ne pourra pas non plus voir les versions enfants des versions répertoriées ici. | 121 |
alternateEmail
Disponible dans API v39 et supérieure | N | L'autre adresse e-mail de cet utilisateur. | "abc@greenco.com" |
samlFedId
Disponible dans API v39 et supérieure | N | L'identifiant SAMFederation de cet utilisateur. | "1234" |
timeZone | O | Fuseau horaire de l'utilisateur. | États-Unis/Pacifique |
page d'accueil
Disponible dans API v39 et supérieure | N | Page d'accueil de l'utilisateur. | "Welcome" |
pays
Disponible dans API v39 et supérieure | N | Code pays de l'utilisateur (code alpha-2). | "US" |
userState
Disponible dans API v39 et supérieure | N | Code d'État de l'utilisateur (le pays doit être les États-Unis). | "CA" |
perspective
Disponible dans API v39 et supérieure | N | Identifiant de perspective pour l'utilisateur. | "111" |
perspectiveName
Disponible dans API v39 et supérieure | N | Nom de la perspective de la perspective de l'utilisateur. | "Tester la perspective" |
tableau de bord
Disponible dans API v39 et supérieure | N | Identifiant du tableau de bord utilisateur - nécessite un identifiant de perspective pour définir l'identifiant du tableau de bord. Si l'identifiant de la perspective est indiqué et que l'identifiant du tableau de bord n'est pas indiqué, alors l'identifiant du tableau de bord est défini sur nul. | "222" |
dashboardName
Disponible dans API v39 et supérieure | N | Nom du tableau de bord du tableau de bord de l'utilisateur. | "Tester le tableau de bord" |
netsuiteLogin
Disponible dans API v39 et supérieure | N | Connexion NetSuite. | "abc@netsuite.com" |
salesforceLogin
Disponible dans API v39 et supérieure | N | Connexion Salesforce. | "abc@salesforce.com" |
createdDate
Disponible dans API v39 et supérieure | N | Date et heure de création de l'utilisateur. | "2023-08-15 08:02:16.0" |
lastLogin
Disponible dans API v39 et supérieure | N | Date et heure de la dernière connexion de l'utilisateur. | "2023-11-13 22:22:39.0" |
failedAttempts
Disponible dans API v39 et supérieure | N | Nombre de tentatives de connexion échouées pour cet utilisateur (suite à la connexion). | "0" |
verrouillé
Disponible dans API v39 et supérieure | N | Si l'utilisateur est verrouillé/ne peut pas être connecté (en raison d'un trop grand nombre de connexions échouées). | "false" |
Contenu de l'élément
| |||
Un élément abonnements. | |||
élément abonnements
| |||
Nom du marqueur
| subscriptions | ||
Description
| Représente les paramètres d'abonnement aux e-mails d'un utilisateur. | ||
Attributs de l'élément
| |||
Nom de l'attribut
| Obligatoire ?
| Valeur
| Exemple
|
nosubscriptions | O | Ce paramètre permet de signaler que l'utilisateur a désactivé tous les abonnements. 1 signifie que l'utilisateur a désactivé tous les abonnements. | 0 |
systemAlertsAndUpdates | O | Les paramètres d'abonnement pour les alertes et mises à jour système activés par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
customerNewsLetter | O | Paramètre pour l'abonnement aux nouvelles lettres d'informations du client choisi par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
localEvents | O | Paramètre de l'abonnement aux événements locaux choisi par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
educationTraining | O | Paramètre de l'abonnement aux événements d'études et de formation choisi par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
customerWebinars | O | Paramètre de l'abonnement aux événements de webinaire client choisi par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
NewProductsAndEnhancements | O | Paramètres de la notification d'amélioration et de nouveau produit choisie par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
partnerNewsLetter | O | Paramètre de l'abonnement aux lettres d'informations des partenaires activé par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
partnerWebinars | O | Paramètre de l'abonnement aux événements de webinaire partenaire activé par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
userGroups | O | Paramètre pour la notification d'événements de groupe d'utilisateurs choisie par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 1 |
enquêtes | O | Paramètre pour la réception des enquêtes par l'utilisateur. 1 signifie que l'utilisateur a activé l'activation et 0 signifie qu'il l'a désactivée. | 0 |
Contenu de l'élément
| |||
aucun(e) | |||