Page Comparison

Boolean

false

Defines whether the organization is virtual.

String

A generated value in UUID format.

Technical name of the organization to be created.

String

The same as technical name.

Human readable name of the organization.

Organization ID

Root organization.

Organization ID of the organization under which the new organization will be created.

String from Configured Set

The configured default organization type. A separate default exists for normal and virtual organizations.

Organization type defining the initial configuration of the created organization.

String

X

Organization's custom attribute and a value (multiple values are separated with comma). For example, vatnumber=12345

friendlyName

String

Human readable name of the organization.

organizationClass

String from Configured Set

Organization type defining the initial configuration of the created organization. Role to role mappings shall be refreshed based on role hierarchy rules only if the organization type is modified.

"custom attribute"

String

X

Organization's custom attribute and a value (multiple values are separated with comma). These attributes must have been defined in eidm2.properties (data.organization.fields or ui.admin.organizationinfo.fields.order) For example, organizationid=12345

login

String

User login name.

email

String

User email address.

firstname

String

First name of the user.

surname

String

Surname of the user.

mobile

String

Mobile phone number.

ssn

String

ssn

String

Social Security Number (henkilötunnus)

locale

String

User preferred locale setting.

pwd

String

New password.

pwd.activated

Boolean

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

status

String from Configured Set

Set the user status Enabled or Disabled.

See Data model - CustomerID for more information on user statuses.

"custom attribute"

String

X

User's custom attribute and a value. For example, age=45. Adding multiple key-value parameters with the same key will create multi-valued attributes. For example, browsers=IE&browsers=chrome.

recursive

Boolean 

false

Include users from the suborganizations (only when listing is performed based on organization path). When query is performed to base path for users the search is global.

<any user attribute name>

String

Include only users with exact matching search criteria value for the specified attribute name(s). You may use any of the builtin or custom attribute names here. The value given is searched from the attribute defined. You may use multiple different attribute names (and limiting search criteria values) in a single query (all must then match for the result to be returned). You cannot use the same attribute name multiple times in a single query.

You can also search by user status . Use either the status code or the status technical name. For example "pending" is equally suitable as "0". See Data model - CustomerID for a list of user status es.

maxResults

Integer

No Limit

Limit the maximum number of results. A value of zero means no limit.

exactMatch

Boolean

false

When limiting attribute values are used, this parameter defines if the value must be found exactly like given (true) or if the database value just needs to start with the given value (false). The attribute is not applicable when users are searched within an organization.

entityName

Entity Name

Search organization by its entity name.

technicalName

String

Search organization by its technical name.

friendlyName

String

Search organizations by their friendly name.

organizationClass

String from Configured Set

Search organizations by their organization type.

<any organization attribute name>

String

Include only organizations with matching search criteria value for the specified attribute name(s). You may use any of the builtin or custom attribute names here that are present in REQ004 output. The value given is searched from the attribute defined. You may use multiple different attribute names (and limiting search criteria values) in a single query (all must then match for the result to be returned). You cannot use the same attribute name multiple times in a single query.

exactMatch

Boolean

false

When limiting attribute values are used, this parameter defines if the value must be found exactly like given (true) or if the database value just needs to start with the given value (false).

entities

Boolean 

false

Return list of entities instead of id list.

entities

Boolean

false

Return list of entities instead of id list.