| Info |
|---|
Last reviewed: 2021-07-22 |
...
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
|---|---|---|---|---|---|
login | String | User login name. | |||
String | User email address. | ||||
firstname | String | First name of the user. | |||
surname | String | Surname of the user. | |||
mobile | String | Mobile phone number. | |||
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. For more information on user statuses see Data model - CustomerID. | |||
"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. |
...
Sends an remainder email for an unregistered user to register without waiting for the remainder period to be passed. There are two different kind of remainder mail messages that are applicable depending on how the initial invitation was made: email.inviteUserRenotify.user and email.inviteUserRenotify.role, see Email text localization.
The email is sent to the email address that is currently set for the user. If original invitation was sent to wrong address, update email address first for example with PUT103 Update User.
The user status must be Waiting for registration in order to be reinvited. This functionality does not support invitations related to mandates.
Target Type
ReinviteResponse
...
With Content-Type header on application/x-www-form-urlencoded
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
|---|---|---|---|---|---|
login | String | User login name. | |||
String | User email address. | ||||
firstname | String | First name of the user. | |||
surname | String | Surname of the user. | |||
mobile | String | Mobile phone number. | |||
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. For more information on user statuses see Data model - CustomerID. | |||
"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. |
...
With Content-Type header on application/xml
| Info |
|---|
Custom Attributes are saved as multivalued. To add multiple value, add multiple values as shown below (Custom1). To remove custom attribute, give no values or give empty value. |
...
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
|---|---|---|---|---|---|
<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 statuses. | |||
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). |
...
Name | Accepted Values | Multivalued | Mandatory | Default | Description |
|---|---|---|---|---|---|
recursive | Boolean | false | Include users from the suborganizations. | ||
<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. |
...
Supported values
- Status: See Data model - CustomerID for a list of user statuses.
- Attributes: Includes user's all attributes (including custom attributes).
...