This object contains all the data related to a user within formcycle. To access the user currently signed in, use XFC_METADATA.user. In case the user is not signed in, the user data refers to an anonymous user. For example, the firstName is set to [Anonymous].

Hierarchy

  • MetadataUser

Index

Properties

authTypeId

authTypeId: string | null

The name of the login method that was used.

displayName

displayName: string

The preferred display name of this user.

familyName

familyName: string | null

The last or family name of this user.

firstName

firstName: string | null

The first or given name of this user.

gender

gender: "FEMALE" | "MALE" | "UNSPECIFIED"

The gender of this user.

groups

groups: string[]

A list of user groups to which this user belongs.

id

id: string

A unique ID of this user, depends on the login method.

linkedId

linkedId: string | null

Identifier of another user profile linked to this user. It usually belongs to the same physical user.

locale

locale: string | null

The locale or preferred language of the user, such as en or de.

mail

mail: string | null

Optional email address of this user.

phone

phone: string | null

The (optional) phone number of this user.

pictureUrl

pictureUrl: string | null

A URL to a picture of the user.

profileUrl

profileUrl: string | null

A URL to the user's profile.

rawData

rawData: JsonObject

All attributes of the user that were returned by the login method. The contents of this JSON object depend on the login method.

You should inspect the value of authTypeId first and check whether it matches the expected login method before accessing these attributes.

role

role: string | null

The formcycle role to which this user was assigned. External users may not have a role set.

title

title: "KEINE_ANGABE" | "HERR" | "FRAU" | "DIVERS"

The form of address of this user.

typedId

typedId: string

A user identifier with a prefix which is the profile type (full Java class name with package).

This identifier is unique throughout all login methods.

userName

userName: string | null

The username of this user.