Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
Last reviewed: 2021-07-22


Tip
Note: The term Remove used in in the APIs is exactly the same as the Delete function.  Calling any API with the Remove term will result in the associated data being deleted from the database. There is no recovery function for these Remove calls.


Table of Contents
maxLevel2

...

Name

Accepted Values

Multivalued

Mandatory

Default

Description

uid

String


X (depending on configuration)


User login name.

email

String


X


User email address.

firstname

String


X


First name of the user.

surname

String


X


Surname of the user.

mobile

String




Mobile phone number.

hetu

String




Social Security Number (henkilötunnus)

pwd

String




Initialize the default password authentication method for the user with the specified password. If missing, the password method is not initialized for the user.

pwd.activated

Boolean




Defines if the password authentication method is actived for the user or not.

sms.activated (Deprecated)

Boolean



false

Defines if the SMS OTP authentication method is actived for the user or not. This parameter is deprecated. SMS OTP related REST services will be provided by OTP Server.

otp.activated (Deprecated)

Boolean



false

Defines if the OTP authentication method is actived for the user or not. This parameter is deprecated. OTP related REST services will be provided by OTP Server.

locale

String




Locale definition. It is used when selecting the right language for email notifications.

"custom attribute"

String

X



User's custom attribute and a value (multiple values are separated with comma). These attributes must have been defined in eidm2.properties (data.user.fields, ui.selfservice.userinfo.fields.order, ui.admin.userinfo.fields.order or ui.admin.approvalinfo.fields.order) For example, age=45

...