updateUser

Kategorie	Änderung von Metadaten
Beschreibung	Aktualisieren Sie Benutzer. Bei Erfolg gibt die API eine Meldung für den Benutzer zurück, die gerade aktualisiert wurde.
Zum Aufrufen sind Berechtigungen erforderlich	Benutzerberechtigung
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält ein Credentials-Tag, um den aufrufenden Benutzer zu identifizieren und zu autorisieren. Benutzer müssen über die Berechtigung "Benutzerberechtigung" verfügen, um den/die Benutzer zu aktualisieren.

Diese Methode steuert oder aktualisiert die eines Benutzers nicht Konzept: Zugriffsregeln (Dimensionszugriffssteuerung).

Diese Methode funktioniert nach der Benutzersynchronisierung mit Workday nicht. Sie ermöglicht nur die Zuweisung von Berechtigungssätzen und dem Zugriff auf Ebenen, bevor
die Benutzersynchronisierung durchgeführt wird.

Anforderungsformat


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

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
anmelden	J	Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen	sampleuser@company.com
Kennwort	J	Das Kennwort des Benutzers, der die API-Methode aufruft.	my_password
Gebietsschema	N	Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den Monatsnamen und der Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet.	fr_FR
instanceCode	N	Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von hat, Adaptive Planning : Dieses Attribut kann verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

-Benutzerelement
Tag-Name		Benutzer
Beschreibung		Gibt einen oder mehrere zu aktualisierende Benutzer an.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
GUID	J	Eine global eindeutige Kennung für den Benutzer. Diese Kennung wird sich für diesen Benutzer nie ändern, auch wenn sich seine Anmeldung oder sein Name in Zukunft ändern. (Die GUID wird auch in der exportUsers-API behandelt.)	B9ADBCB81AA2F9BAE040307F02092C2E
E-Mail	N	Die E-Mail-Adresse für diesen Benutzer. Eindeutigkeit ist erforderlich. Die einzigen zulässigen Zeichen sind az, AZ, 0-9, - und. Diese E-Mail-Adresse gibt den Benutzernamen an.	newUser@company.com
Name	N	Der Name dieses Benutzers.	Melden Sie sich an
Stelle Verfügbar in API v39 und höher	N	Stelle für Benutzer.	"CEO"
Kennwort	N	Das Kennwort dieses Benutzers. Wenn Sie einen Benutzer aktualisieren, der sich in einer Multiinstanz-Umgebung befindet, können Sie nur Kennwortänderungen in seiner Standardinstanz angeben.	neues Kennwort
alternateEmail Verfügbar in API v27	N	Die alternative E-Mail-Adresse für diesen Benutzer. Diese Option wird automatisch ausgewählt und im Abschnitt Benutzerdetails wird die E-Mail-ID des Benutzers automatisch geladen.	abc@greenco.com
samlFedId Verfügbar in API v27	N	Die SAML-Federation-ID für diesen Benutzer.	1234, user@company.com
permissionSetId Verfügbar in API v25 und höher	N	Die interne System-ID des Berechtigungssatzes, der diesem Benutzer zugewiesen ist.	3
roleId Verfügbar in API v25 und früher Nicht verfügbar in API v25 und höher	N	Die interne System-ID der Rolle, die diesem Benutzer zugewiesen ist. (Das Attribut roleId wird auch in der exportRoles-API behandelt.)	3
ownedLevels	N	Die interne System-ID für die durch Komma getrennten Ebenen. (Das Attribut ownerLevels wird auch in der exportLevels-API behandelt.)	5,10,13
Homepage Verfügbar in API v39 und höher	N	Homepage für Benutzer.	"Willkommen"
timeZone	N	Die Zeitzone des Benutzers.	USA/pazifik
Land Verfügbar in API v39 und höher	N	Ländercode für Benutzer (Alpha-2-Code).	"US"
usState Verfügbar in API v39 und höher	N	Code des Bundesstaates für Benutzer (Land muss USA sein).	"CA"
Perspektive Verfügbar in API v39 und höher	N	Perspektiven-ID des Benutzers.	"111"
Dashboard Verfügbar in API v39 und höher	N	Dashboard-ID für Benutzer – Erfordert eine Perspektiven-ID zum Festlegen der Dashboard-ID. Wenn eine Perspektiven-ID angegeben ist und eine Dashboard-ID nicht, wird die Dashboard-ID auf „0“ gesetzt.	"222"
netsuiteLogin Verfügbar in API v39 und höher	N	NetSuite-Anmeldung.	"abc@netsuite.com"
salesforceLogin Verfügbar in API v39 und höher	N	Salesforce-Anmeldung.	"abc@salesforce.com"
Inhalt des Elements
(Keine)

Antwortformat


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

Antwortelement
Tag-Name		-Antwort
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten.	wahr
Inhalt des Elements
Ein einzelnes Ergebniselement mit den Statuselementen „created_user“ oder „update_user“, je nachdem, ob ein createUser- oder updateUser-Aufruf erfolgt ist.

Element resultieren
Tag-Name		Ergebnis
Beschreibung		Container für ein oder mehrere Statuselemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein oder mehrere Statuselemente „created_user“ oder „update_user“, je nachdem, ob ein createUser- oder updateUser-Aufruf erfolgt ist.

Element update_users
Tag-Name		updated_users
Beschreibung		Stellt eine Nachricht dar, die vom System an den Aufrufer zurückgesendet wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Benutzer erfolgreich	J	Der vom Aufruf zurückgegebene Status. Kann wahr oder falsch sein.	wahr
Nachricht	J	Statusmeldung.	-Benutzernewuser@company.com wurde erfolgreich aktualisiert.
Inhalt des Elements
Ein Abonnementelement.