exportUsers

élément de données d'identification

Nom du marqueur

données d'identification

Description

Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté réussir.

Attributs de l'élément

Nom de l’attribut

Obligatoire?

Valeur

ouvrir une session

Y

Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour invoquer la méthode.

mot de passe

Y

Le mot de passe de l’utilisateur qui invoque la méthode API.

paramètres régionaux

N

Indiquez les paramètres régionaux à utiliser pour interpréter les numéros et les dates entrants et pour mettre en forme les numéros et les dates sortants (à l’aide du séparateur des milliers, des noms de mois et du format de date appropriés). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée.

instanceCode

N

Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de

Adaptive Planning

, cet attribut peut être utilisé pour préciser que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances disponibles, utilisez l’API exportInstances.

Contenu de l'élément

(aucun)

Nom du marqueur

inclure

Description

Représente un ensemble d’indicateurs indiquant quels aspects de l’information sur les utilisateurs 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 vraies pour ownerLevels et fausses pour HideVersions.

Attributs de l'élément

Nom de l’attribut

Obligatoire?

Valeur

N

Le mot est vrai ou faux. Indique si les éléments utilisateur dans la réponse incluent un attribut groupIds. Si la valeur est vraie, groupIds dans la réponse contient une liste de tous les groupes séparés par des virgules dans lesquels l’utilisateur est inclus. Si l’attribut n’est pas présent ou si sa valeur est autre que vraie ou fausse, la valeur par défaut faux est utilisée.

N

Le mot est vrai ou faux. Indique si les éléments utilisateur de la réponse doivent inclure ou non des attributs ownerLevels. Si l’attribut n’est pas présent ou si sa valeur est autre que vraie ou fausse, la valeur par défaut de vrai est utilisée.

N

Le mot est vrai ou faux. Indique si les éléments utilisateur dans la réponse doivent inclure ou non des attributs HideVersions. Si l’attribut n’est pas présent ou si sa valeur est autre que vraie ou fausse, la valeur par défaut faux est utilisée.

Contenu de l'élément

(aucun)

élément de réponse

Nom du marqueur

réponse

Attributs de l'élément

Nom de l’attribut

Obligatoire?

Valeur

réussite

Y

Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.

obsolète

N

S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée. Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent.

Contenu de l'élément

Un seul élément de message facultatif et un seul élément de sortie obligatoire.

élément de sortie

Nom du marqueur

Attributs de l'élément

(aucun)

Contenu de l'élément

Un élément de comptes unique. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi.

élément users

Nom du marqueur

utilisateurs

Description

Conteneur pour un ou plusieurs éléments utilisateur.

Attributs de l'élément

Nom de l’attribut

Obligatoire?

Valeur

Contenu de l'élément

Un ou plusieurs éléments utilisateur.

élément utilisateur

Nom du marqueur

utilisateur

Description

Représente un utilisateur unique retourné en réponse à un appel d’API exportUsers.

Attributs de l'élément

Nom de l’attribut

Obligatoire?

Valeur

identifiant

Y

Il s’agit du numéro d’identifiant de système interne pour l’utilisateur.

GUID

Y

Un identifiant global unique pour l’utilisateur. Cet utilisateur ne changera jamais, même si son identifiant de connexion ou son nom change à l'avenir.

ouvrir une session

Y

L'identifiant de connexion pour cet utilisateur.

courriel

Y

L'adresse de courriel de cet utilisateur. Peut être vide si l’utilisateur n’a pas configuré une adresse de courriel valide.

nom

Y

Le nom de cet utilisateur.

position

N

Un poste pour l’utilisateur.

Y

L’identifiant de système interne de l’ensemble d’autorisations affecté à cet utilisateur. Voir également exportPermissionSets.

permissionSetIds

Y

Les identifiants du système interne des ensembles d’autorisations affectés à cet utilisateur. Voir également exportPermissionSets.

Y

L’identifiant de système interne du rôle affecté à cet utilisateur. Voir également exportRoles.

Y

Cet attribut est inclus uniquement si l’utilisateur inclus dans les données d’identification de la demande a l’autorisation de niveau Administrateur pour l’ensemble de l’arborescence de l’organisation et que la demande a indiqué que ownerLevels doit être inclus. S’il est inclus, la valeur de cet attribut est une liste d’identifiants de système interne séparés par des virgules pour les niveaux d’organisation auxquels cet utilisateur a accès directement. L'utilisateur aura également accès à tous les niveaux enfants des niveaux répertoriés ici

N (voir description)

Cet attribut n’est inclus que si l’utilisateur inclus dans les données d’identification de la demande dispose de l’autorisation de l’administrateur des versions et que la demande a indiqué que HideVersions doit être inclus. S’il est inclus, la valeur de cet attribut est une liste séparée par des virgules d’identifiants de système interne pour les versions ou les dossiers de version qui sont masqués pour cet utilisateur (mais dont le parent est inexistant ou n’est pas masqué). L'utilisateur ne pourra pas non plus voir les versions enfants des versions répertoriées ici.

alternateEmail

N

L'autre adresse de courriel de cet utilisateur.

samlFedId

N

L'identifiant SAMFLederation pour cet utilisateur.

timeZone

Y

Le fuseau horaire de l’utilisateur.

page d'accueil

N

Page d’accueil pour l’utilisateur.

pays

N

Code de pays de l’utilisateur (code alpha-2).

usState

N

Code d’État pour l’utilisateur (le pays doit être É.-U.).

perspective

N

Identifiant de perspective pour l'utilisateur.

perspectiveName

N

Nom de la perspective de l'utilisateur.

tableau de bord

N

Identifiant de tableau de bord pour l’utilisateur – l’identifiant de perspective doit définir l’identifiant du tableau de bord; si l’identifiant de perspective est précisé et que l’identifiant du tableau de bord n’est pas, l’identifiant du tableau de bord est défini à zéro.

dashboardName

N

Tableau de bord Nom du tableau de bord de l'utilisateur.

netsuiteLogin

N

Ouverture de session Netsuite.

salesforceLogin

N

Ouvrir une session Salesforce.

createdDate

N

Date et heure auxquelles l'utilisateur a été créé.

lastLogin

N

Date et heure de la dernière ouverture de session de l’utilisateur.

failedAttempts

N

Nombre de tentatives d’ouverture de session pour cet utilisateur (consécutives).

verrouillé

N

Si l’utilisateur est verrouillé ou ne peut pas être connecté (en raison d’un trop grand nombre d’échecs de connexion).

Contenu de l'élément

Un élément d’abonnement.

élément lié aux abonnements

Nom du marqueur

subscriptions

Description

Représente les paramètres d’abonnement aux courriels d’un utilisateur.

Attributs de l'élément

Nom de l’attribut

Obligatoire?

Valeur

nosubscriptions

Y

Paramètre pour signaler que l’utilisateur a choisi de ne pas utiliser tous les abonnements. 1 signifie que l’utilisateur a choisi de ne pas utiliser tous les abonnements.

systemAlertsAndUpdates

Y

Paramètre d’abonnement aux alertes système et aux mises à jour choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

customerNewsLetter

Y

Paramètre pour l’abonnement à des lettres d’informations du client choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

localEvents

Y

Paramètre pour l’abonnement aux événements locaux choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

educationTraining

Y

Paramètre pour l’abonnement aux événements d’études et de formation choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

customerWebinars

Y

Paramètre d’abonnement aux événements de webinaires des clients choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

newProduitsetaméliorations

Y

Paramètre de notification de nouveaux produits et améliorations choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

partnerNewsLetter

Y

Paramètre d’abonnement aux lettres d’informations du partenaire choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

partnerWebinars

Y

Paramètre d’abonnement aux événements de webinaires des partenaires choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

userGroups

Y

Paramètre de notification des événements des groupes d’utilisateurs choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

sondages

Y

Paramètre pour recevoir des sondages choisi par l’utilisateur. 1 signifie que l’utilisateur a choisi d’utiliser et 0  signifie qu’il a choisi de ne pas utiliser cette fonction.

Contenu de l'élément

aucun