updateUser

Catégorie	Modification de métadonnées
Description	Mettez à jour un ou plusieurs utilisateurs. En cas de réussite, l’API renvoie un message pour l’utilisateur qui vient d’être mis à jour.
Autorisations obligatoires pour pouvoir être appelées	Autorisation utilisateur
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient un marqueur d’identifiants pour désigner et autoriser l’utilisateur auteur de l’appel. L'utilisateur doit avoir l'autorisation de type Autorisation utilisateur pour mettre à jour le ou les utilisateur(s).

Cette méthode ne contrôle ni ne met à jour les données d’un utilisateur Concept : règles d’accès (contrôle d’accès aux dimensions).

Cette méthode ne fonctionne pas après la synchronisation des utilisateurs à partir de Workday. Il est uniquement possible d’affecter des ensembles d’autorisations et un accès de niveau avant
la synchronisation des utilisateurs.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateUser" callerName="a string that identifies your client application">
     <credentials login="sampleuser@company.com" password="my_pwd" />
       <users>
           <user
             guid="B9ADBCB81AA2F9BAE040307F02092C2E"
             email="updateMail@company.com"
             name="update name"
             password="new Password"
             alternateEmail="abc@greenco.com"
             samlFedId="1234"
             permissionSetId="1"
             ownedLevels="2,3,7,11"
             timeZone="America/Mexico_City"
                  />
      </users>
</call>

é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	Exemple
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 appeler la méthode	sampleuser@company.com
mot de passe	Y	Le mot de passe de l’utilisateur qui invoque la méthode API.	my_password
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.	fr_FR
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.	MYINSTANCE1
Contenu de l'élément
(aucun)

élément utilisateur
Nom du marqueur		utilisateur
Description		Indique un ou plusieurs utilisateurs à mettre à jour.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
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. (Le GUID est également couvert par l’API exportUsers)	B9ADBCB81AA2F9BAE040307F02092C2E
courriel	N	L'adresse de courriel de cet utilisateur. L’unicité est requise. Les seuls caractères autorisés sont az, z, 0-9, - et . Cette adresse de courriel indique le nom d'utilisateur.	newUser@company.com
nom	N	Le nom de cet utilisateur.	Melvin Mor priser
position Disponible dans l'API v39+	N	Un poste pour l’utilisateur.	"CEO"
mot de passe	N	Le mot de passe de cet utilisateur. Si vous mettez à jour un utilisateur qui se trouve dans un environnement à plusieurs instances, vous pouvez préciser les changements de mot de passe uniquement dans son instance par défaut.	nouveauMot de passe
alternateEmail Disponible dans l'API v27	N	L'autre adresse de courriel de cet utilisateur. Workday sélectionne automatiquement cette option et la remplit avec l’identifiant de courriel de l’utilisateur dans la section Détails de l’utilisateur.	abc@greenco.com
samlFedId Disponible dans l'API v27	N	L'identifiant de fédération SAML pour cet utilisateur.	1234, user@company.com
permissionSetId Disponible dans l'API v25+	N	L’identifiant de système interne de l’ensemble d’autorisations affecté à cet utilisateur.	3
roleId Disponible dans l'API v25 et dans les versions antérieures Non disponible dans l’API v25+	N	L’identifiant de système interne du rôle affecté à cet utilisateur. (L’attribut roleId est également traité dans l’API exportRoles.)	3
ownerLevels	N	L'identifiant de système interne pour les niveaux séparés par des virgules. (L’attribut ownerLevels est également couvert par l’API exportLevels.)	5,10,13
page d'accueil Disponible dans l'API v39+	N	Page d’accueil pour l’utilisateur.	"Welcome"
timeZone	N	Le fuseau horaire de l’utilisateur.	É.-U./Pacifique
pays Disponible dans l'API v39+	N	Code de pays de l’utilisateur (code alpha-2).	« US »
usState Disponible dans l'API v39+	N	Code d’État pour l’utilisateur (le pays doit être É.-U.).	"CA"
perspective Disponible dans l'API v39+	N	Identifiant de perspective pour l'utilisateur.	"111"
tableau de bord Disponible dans l'API v39+	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.	"222"
netsuiteLogin Disponible dans l'API v39+	N	Ouverture de session Netsuite.	"abc@netsuite.com"
salesforceLogin Disponible dans l'API v39+	N	Ouvrir une session Salesforce.	"abc@salesforce.com"
Contenu de l'élément
(aucun)

Format de réponse


<?xml version='1.0' encoding='UTF-8'?>
 <response success="true">
    <output>
        <result>
              <updated_users>
                  <user success="true" message="user newUser@company.com was updated successfully."/>
              </updated_users>
        </result>
    </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	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.	vrai
Contenu de l'élément
Un seul élément de résultat avec des éléments de statut created_user ou update_user selon que l’appel de CreateUser ou de updateUser a été fait, respectivement.

élément de résultat
Nom du marqueur		résultat
Description		Conteneur pour un ou plusieurs éléments de statut.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de statut created_user ou update_user selon que l’appel de CreateUser ou de updateUser a été fait, respectivement.

élément update_users
Nom du marqueur		mis à jour_utilisateurs
Description		Représente un message renvoyé par le système à l’appelant.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
succès utilisateur	Y	Le statut renvoyé par l’appel. Peut être vrai ou faux.	vrai
message	Y	Le message lié au statut.	utilisateurnewuser@company.com a été mis à jour.
Contenu de l'élément
Un élément d’abonnement.