Update User | X4Documentation

Die Operation Update User aktualisiert die Daten des Benutzers mit der angegebenen ID. Die Daten werden in der vom Adapter erwarteten Input-XML definiert.

Der Benutzername kann nicht aktualisiert werden.

Input-XML

XML

<?xml version="1.0" encoding="UTF-8"?>
<User>
	<Id></Id>
	<Enabled></Enabled>
	<Totp></Totp>
	<EmailVerified></EmailVerified>
	<FirstName></FirstName>
	<LastName></LastName>
	<Email></Email>
	<Attributes>
		<Attribute>
			<Name></Name>
			<Values>
				<Value></Value>
			</Values>
		</Attribute>
	</Attributes>
	<Credentials>
		<Credential>
			<Type></Type>
			<Value></Value>
			<Temporary></Temporary>
		</Credential>
	</Credentials>
	<RequiredActions></RequiredActions>
	<NotBefore></NotBefore>
</User>

Element	Beschreibung	Mögliche Werte
`User`	Benutzerdefinition	Das Element enthält folgende Elemente: `Id` `FirstName` (optional) `LastName` (optional) `Email` (optional) `EmailVerified` (optional) `Enabled` (optional) `Totp` (optional) `Attributes` (optional) `Credentials` (optional) `RequiredActions` (optional) `NotBefore` (optional)
`Id`	Eindeutige ID des Benutzers	UUID
`FirstName`	Der Vorname des Benutzers	Beliebiger String
`LastName`	Der Nachname des Benutzers	Beliebiger String
`Email`	Die E-Mail-Adresse des Benutzers	E-Mail-Adresse
`EmailVerified`	Angabe, ob die angegebene E-Mail-Adresse verifiziert ist	`true`: Die E-Mail-Adresse ist verifiziert. `false`: Die E-Mail-Adresse ist nicht verifiziert.
`Enabled`	Angabe, ob der Benutzer aktiviert oder deaktiviert ist	`true`: Der Benutzer ist aktiviert. `false`: Der Benutzer ist deaktiviert.
`Totp`	Angabe, ob das Passwort nach der ersten Anmeldung ungültig ist	`true`: Der Benutzer muss nach der ersten Anmeldung das Passwort ändern. `false`: Der Benutzer muss das Passwort nicht ändern.
`Attributes`	Personalisierte, konfigurierbare Attribute	Das Element enthält folgende Elemente: `Attribute` (Mehrfachdeklaration möglich)
`Credentials`	Benutzeranmeldeinformationen	Das Element enthält folgendes Element: `Credential`
`RequiredActions`	Angabe, ob vom Benutzer zur Handlung aufgefordert wird, sobald der Benutzer sich anmeldet.	`VERIFY_EMAIL`: Der Benutzer muss nach der Anmeldung seine E-Mail-Adresse verifizieren. `UPDATE_PROFILE`: Der Benutzer muss nach der Anmeldung sein Benutzerprofil aktualisieren. `UPDATE_PASSWORD`: Der Benutzer muss nach der Anmeldung sein Passwort aktualisieren.
`NotBefore`	Die Anzahl der fehlgeschlagenen Anmeldeversuche	Ganzzahl

Attributes

Element	Beschreibung
`Attributes`	Personalisierte, konfigurierbare Attribute	Das Element enthält folgende Elemente: `Attribute` (Mehrfachdeklaration möglich)
`Attribute`	Personalisiertes, konfigurierbares Attribut	Das Element enthält folgende Elemente: `Name` `Values`
`Name`	Attributname	Beliebiger String
`Values`	Attributwerte	Das Element enthält folgende Elemente: `Value` (Mehrfachdeklaration möglich)
`Value`	Attributwert	Beliebiger String

Credentials

Im Credentials-Element wird die Art des Anmeldedatensatzes und der dazugehörige Wert festgelegt. Das kann zum Beispiel ein Passwort sein.

Element	Beschreibung	Mögliche Werte
`Credentials`	Benutzeranmeldeinformationen	Das Element enthält folgende Elemente: `Credential`
`Credential`	Anmeldedatensatz	Das Element enthält folgende Elemente: `Type` `Value` `Temporary`
`Type`	Art des Anmeldedatensatzes, z. B. Passwort	`password`: Der Anmeldedatensatz ist ein Passwort.
`Value`	Attributwert	Beliebiger String
`Temporary`	Angabe, ob das Passwort temporär ist	`true`: Das Passwort ist temporär. `false`: Das Passwort ist nicht temporär.

XSD

XML

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
	<xs:element name="User">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Id"/>
				<xs:element ref="Enabled"/>
				<xs:element ref="Totp"/>
				<xs:element ref="EmailVerified"/>
				<xs:element ref="FirstName"/>
				<xs:element ref="LastName"/>
				<xs:element ref="Email"/>
				<xs:element ref="Attributes"/>
				<xs:element ref="Credentials"/>
				<xs:element ref="RequiredActions"/>
				<xs:element ref="NotBefore"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Id" type="xs:string"/>
	<xs:element name="Enabled" type="xs:boolean"/>
	<xs:element name="Totp" type="xs:boolean"/>
	<xs:element name="EmailVerified" type="xs:boolean"/>
	<xs:element name="FirstName" type="xs:NCName"/>
	<xs:element name="LastName" type="xs:NCName"/>
	<xs:element name="Email" type="xs:string"/>
	<xs:element name="Attributes">
		<xs:complexType>
			<xs:sequence>
				<xs:element maxOccurs="unbounded" ref="Attribute"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Attribute">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Name"/>
				<xs:element ref="Values"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Name" type="xs:string"/>
	<xs:element name="Values">
		<xs:complexType>
			<xs:sequence>
				<xs:element maxOccurs="unbounded" ref="Value"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Credentials">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Credential"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Credential">
		<xs:complexType>
			<xs:sequence>
				<xs:element ref="Type"/>
				<xs:element ref="Value"/>
				<xs:element ref="Temporary"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Type" type="xs:NCName"/>
	<xs:element name="Temporary" type="xs:boolean"/>
	<xs:element name="RequiredActions" type="xs:NCName"/>
	<xs:element name="NotBefore" type="xs:integer"/>
	<xs:element name="Value" type="xs:string"/>
</xs:schema>

Beispiele

Input

XML

<?xml version="1.0" encoding="UTF-8"?>
<User>
	<Id>2302cf2f-9b29-4d62-9c48-67ac5e3b0ddc</Id>
	<Enabled>true</Enabled>
	<Totp>false</Totp>
	<EmailVerified>true</EmailVerified>
	<FirstName>Jane</FirstName>
	<LastName>Doe</LastName>
	<Email>john.doe@example.com</Email>
	<Attributes>
		<Attribute>
			<Name>Employment Relationship</Name>
			<Values>
				<Value>Software Developer</Value>
				<Value>Sub-Team Lead</Value>
			</Values>
		</Attribute>
	</Attributes>
	<Credentials>
		<Credential>
			<Type>password</Type>
			<Value>password123</Value>
			<Temporary>false</Temporary>
		</Credential>
	</Credentials>
	<RequiredActions>VERIFY_EMAIL</RequiredActions>
	<NotBefore>0</NotBefore>
</User>