updateUser

Categoria	Modifica dei metadati
Descrizione	Aggiornare uno o più utenti. In caso di esito positivo, l'API restituirà un messaggio per l'utente appena aggiornato.
Autorizzazioni necessarie per richiamare	Autorizzazione utente
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante. L'utente deve disporre dell'autorizzazione "Autorizzazione utente" per aggiornare gli utenti.

Questo metodo non controlla né aggiorna i dati di un utente Concetto: Regole di accesso (controllo dell'accesso alle dimensioni).

Questo metodo non funziona dopo la sincronizzazione degli utenti da Workday. Consente di assegnare insiemi di autorizzazioni e livelli di accesso solo prima
che venga eseguita la sincronizzazione degli utenti.

Formato richiesta


<?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>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere un singolo elemento di credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
accedere	S	Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo	sampleuser@company.com
password	S	La password dell'utente che richiama il metodo API.	my_password
impostazioni internazionali	N	Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei mesi e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).	fr_FR
instanceCode	N	Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning , questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

elemento utente
Nome tag		utente
Descrizione		Specifica uno o più utenti da aggiornare.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
guid	S	Identificatore univoco globale per l'utente. Questo identificativo non cambierà mai per questo utente, anche se il nome o l'accesso verranno modificati in futuro. (Il guid è incluso anche nell'API exportUsers)	B9ADBCB81AA2F9BAE040307F02092C2E
email	N	L'indirizzo e-mail dell'utente. L'unicità è obbligatoria. Gli unici caratteri consentiti sono az, AZ, 0-9, - e . Questo indirizzo e-mail indica il nome utente.	newUser@company.com
nome	N	Il nome dell'utente.	Melvin Morsmere
posizione Disponibile nell'API v39+	N	Posizione per l'utente	"CEO"
password	N	La password dell'utente. Se si aggiorna un utente che si trova in un ambiente a istanze multiple, è possibile specificare le modifiche della password solo nell'istanza predefinita.	newpassword
alternateEmail Disponibile nell'API v27	N	L'indirizzo e-mail alternativo dell'utente. Questa opzione viene selezionata automaticamente e viene inserita l'ID e-mail dell'utente nella sezione Dettagli utente.	abc@greenco.com
samlFedId Disponibile nell'API v27	N	ID federazione SAML per questo utente.	1234, user@company.com
permissionSetId Disponibile nell'API v25+	N	L'ID di sistema interno del set di autorizzazioni assegnato all'utente.	3
roleId Disponibile nell'API v25 e versioni precedenti Non disponibile nell'API v25+	N	L'ID sistema interno del ruolo assegnato a questo utente. L'attributo roleId è incluso anche nell'API exportRoles.	3
possedutoLevels	N	L'ID sistema interno per i livelli separati da virgole. L'attributoownedLevels è incluso anche nell'API exportLevels.	5,10,13
home page Disponibile nell'API v39+	N	Home page per l'utente	"Benvenuto"
timeZone	N	Il fuso orario dell'utente.	USA/Pacifico
paese Disponibile nell'API v39+	N	Prefisso internazionale per utente (codice alfa-2).	"US"
usState Disponibile nell'API v39+	N	Codice stato per utente (il paese deve essere USA).	"CA"
prospettiva Disponibile nell'API v39+	N	ID prospettiva per l'utente	"111"
dashboard Disponibile nell'API v39+	N	ID dashboard per utente: è necessario che l'ID prospettiva imposti l'ID dashboard, se l'ID prospettiva è specificato e l'ID dashboard non lo è, l'ID dashboard è impostato su null.	"222"
netsuiteLogin Disponibile nell'API v39+	N	Accesso a Netsuite.	"abc@netsuite.com"
salesforceLogin Disponibile nell'API v39+	N	Accesso a Salesforce	"abc@salesforce.com"
Contenuto dell'elemento
(nessuno)

Formato risposta


<?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>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	Vero o falso, a indicare se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	true
Contenuto dell'elemento
Un singolo elemento di risultato con elementi di stato create_user o update_user a seconda che sia stata effettuata rispettivamente una chiamata createUser o updateUser.

elemento risultato
Nome tag		risultato
Descrizione		Contenitore per uno o più elementi di stato.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
(nessuno)
Contenuto dell'elemento
Uno o più elementi di stato create_user o update_user a seconda che sia stata effettuata rispettivamente una chiamata createUser o updateUser.

updated_users element
Nome tag		updated_users
Descrizione		Rappresenta un messaggio inviato dal sistema al chiamante.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
utente riuscito	S	Lo stato restituito dalla chiamata. Può essere vero o falso.	true
messaggio	S	Il messaggio di stato	utentenuovoutente@azienda.com è stato aggiornato.
Contenuto dell'elemento
Un elemento di iscrizioni.