User Identity Adapter | X4Documentation

This adapter allows retrieving information about the currently logged-in user, e.g. username, first and last name, set language, email address and groups this user is assigned to.

If a non-default realm is used, a mapper of type Group Membership must be set up in the client. The configuration can be found in the Administration Guide, in the Default Configuration section.

Properties

Operation

Operation executed by the adapter

Possible values:

GetUserIdentity: Returns the information about the user.

Parameter

`Adapter`	Adapter main class (do not change!) Possible values: `de.softproject.x4.adapter.useridentity.UserIdentityAdapter`: Main class (default)
`generateTestGroup`	Defines whether a test group entry should be generated when the adapter is executed in debug mode. (information) Works only in debug mode. Possible values: `true`: Generate an test group entry `false`: Do not generate an test group entry
`testGroupName`	Technical name of the test group entry if `generateTestGroup` is set to `true`.
`testGroupDisplayName`	Displayed name of the test group entry if `generateTestGroup` is set to `true`.
`username`	Used username if `generateTestGroup` is set to `true`.
`lastname`	Last name used if `generateTestGroup` is set to `true`.
`firstname`	First name used if `generateTestGroup` is set to `true`.
`email`	Email address used if `generateTestGroup` is set to `true`.
`timezone`	User time zone according to ISO 8601 output in debug mode. Possible values: Time zone according to ISO 8601 duration format, e.g. `PT5H`

Status values

`1`	The adapter operation was executed successfully.
`-1`	An error occurred while executing the adapter.

Output XML

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Result>
	<Username></Username>
	<Language></Language>
	<Groups>
		<Group>
			<Name></Name>
			<DisplayName></DisplayName>
		</Group>
		<Group>
			<Name></Name>
			<DisplayName></DisplayName>
		</Group>
	</Groups>
	<Timezone>
		<Offset></Offset>
	</Timezone>
    <AccessToken></AccessToken>
	<SessionId></SessionId>
	<Claims>
		<Claim key="" value=""/>
		<Claim key="" value=""/>
		<ComplexClaim key="" type="">
			<ComplexClaim key="" type="">
				<ComplexClaim key="" type="">
					<Entry value=""/>
					<Entry value=""/>
					<Entry value=""/>
				</ComplexClaim>
				<isParent></isParent>
			</ComplexClaim>
			<isParent></isParent>
		</ComplexClaim>
	</Claims>
</Result>

XSD

XML

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="Result" type="ResultType"/>
	<xs:complexType name="GroupType">
		<xs:sequence>
			<xs:element type="xs:string" name="Name"/>
			<xs:element type="xs:string" name="DisplayName"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="GroupsType">
		<xs:sequence>
			<xs:element type="GroupType" name="Group" maxOccurs="unbounded" minOccurs="0"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="TimezoneType">
		<xs:sequence>
			<xs:element type="xs:duration" name="Offset"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="ClaimType">
		<xs:simpleContent>
			<xs:extension base="xs:string">
				<xs:attribute type="xs:string" name="key" use="optional"/>
				<xs:attribute type="xs:string" name="value" use="optional"/>
			</xs:extension>
		</xs:simpleContent>
	</xs:complexType>
	<xs:complexType name="EntryType">
		<xs:simpleContent>
			<xs:extension base="xs:string">
				<xs:attribute type="xs:string" name="value" use="optional"/>
			</xs:extension>
		</xs:simpleContent>
	</xs:complexType>
	<xs:complexType name="ComplexClaimType">
		<xs:sequence>
			<xs:element type="EntryType" name="Entry" maxOccurs="unbounded" minOccurs="0"/>
			<xs:element type="ComplexClaimType" name="ComplexClaim" minOccurs="0"/>
			<xs:element type="ClaimType" name="Claim" maxOccurs="unbounded" minOccurs="0"/>
		</xs:sequence>
		<xs:attribute type="xs:string" name="key" use="optional"/>
		<xs:attribute type="xs:string" name="type" use="optional"/>
	</xs:complexType>
	<xs:complexType name="ClaimsType">
		<xs:sequence>
			<xs:element type="ClaimType" name="Claim" maxOccurs="unbounded" minOccurs="0"/>
			<xs:element type="ComplexClaimType" name="ComplexClaim" maxOccurs="unbounded" minOccurs="0"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="ResultType">
		<xs:sequence>
			<xs:element type="xs:string" name="Username"/>
			<xs:element type="xs:string" name="Language"/>
			<xs:element type="GroupsType" name="Groups"/>
			<xs:element type="TimezoneType" name="Timezone"/>
			<xs:element type="xs:string" name="AccessToken"/>
			<xs:element type="xs:string" name="SessionId"/>
			<xs:element type="ClaimsType" name="Claims"/>
		</xs:sequence>
	</xs:complexType>
</xs:schema>