Skip to main content
Skip table of contents

Create new User

Die Operation Create new User erstellt in Keycloak einen neuen Benutzer. Die Daten werden in der vom Adapter erwarteten Input-XML definiert.

Input-XML

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

User

ElementBeschreibungMögliche Werte
User

Das Element enthält folgende Elemente:

  • Username
  • FirstName (optional)
  • LastName (optional)
  • Email (optional)
  • EmailVerified (optional)
  • Enabled (optional)
  • Attributes (optional)
  • Credentials (optional)
UsernameDer vom Benutzer gewünschte BenutzernameBeliebiger String
FirstNameDer Vorname des BenutzersBeliebiger String
LastNameDer Nachname des BenutzersBeliebiger String
EmailDie E-Mail-Adresse des BenutzersE-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.
EnabledAngabe, ob der Benutzer aktiviert oder deaktiviert ist
  • true: Der Benutzer ist aktiviert.
  • false: Der Benutzer ist deaktiviert.
Attributes

Personalisierte, konfigurierbare Attribute

Das Element enthält folgende Elemente:

  • Attribute (Mehrfachdeklaration möglich)
Credentials

Benutzeranmeldeinformationen

Das Element enthält folgendes Element:

  • Credential

Attributes

ElementBeschreibung
AttributesPersonalisierte, konfigurierbare Attribute

Das Element enthält folgende Elemente:

  • Attribute (Mehrfachdeklaration möglich)
Attribute

Personalisiertes, konfigurierbares Attribut

Das Element enthält folgende Elemente:

  • Name
  • Values
NameAttributnameBeliebiger String
Values

Attributwerte

Das Element enthält folgende Elemente:

  • Value (Mehrfachdeklaration möglich)
ValueAttributwertBeliebiger String

Credentials

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

ElementBeschreibungMögliche Werte
CredentialsBenutzeranmeldeinformationen

Das Element enthält folgende Elemente:

  • Credential
CredentialAnmeldedatensatz

Das Element enthält folgende Elemente:

  • Type
  • Value
  • Temporary
TypeArt des Anmeldedatensatzes, z. B. Passwort

password: Der Anmeldedatensatz ist ein Passwort.

ValueAttributwertBeliebiger 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="Username"/>
				<xs:element ref="FirstName"/>
				<xs:element ref="LastName"/>
				<xs:element ref="Email"/>
				<xs:element ref="EmailVerified"/>
				<xs:element ref="Enabled"/>
				<xs:element ref="Attributes"/>
				<xs:element ref="Credentials"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="Username" type="xs:NCName"/>
	<xs:element name="FirstName" type="xs:NCName"/>
	<xs:element name="LastName" type="xs:NCName"/>
	<xs:element name="Email" type="xs:string"/>
	<xs:element name="EmailVerified" type="xs:boolean"/>
	<xs:element name="Enabled" type="xs:boolean"/>
	<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="Value" type="xs:string"/>
</xs:schema>

Beispiele

Input

XML
<?xml version="1.0" encoding="UTF-8"?>
<User>
	<Username>JohnDoe</Username>
	<FirstName>John</FirstName>
	<LastName>Doe</LastName>
	<Email>John.Doe@example.com</Email>
	<EmailVerified>true</EmailVerified>
	<Enabled>true</Enabled>
	<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>
</User>
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.