SendWelcomeEmailForUser API¶
Sends a welcome email to a specified user. For native-authenticated users the email includes a 48-hour password reset link. For externally-authenticated users it includes their authentication source name. Requires system administrator privileges.
Endpoint¶
Methods¶
- GET
/srv.asmx/SendWelcomeEmailForUser?authenticationTicket=...&userName=... - POST
/srv.asmx/SendWelcomeEmailForUser(form data) - SOAP Action:
http://tempuri.org/SendWelcomeEmailForUser
Parameters¶
| Parameter | Type | Required | Description |
|---|---|---|---|
authenticationTicket |
string | Yes | Authentication ticket obtained from AuthenticateUser |
userName |
string | Yes | The username of the user to send the welcome email to |
Response¶
Success Response¶
Error Response¶
Required Permissions¶
Caller must be a system administrator.
Email Content¶
The email sent depends on the user's authentication type:
| Authentication Type | Email Template | Password Reset Link |
|---|---|---|
| Native (infoRouter) | WELCOMETOIR |
Yes — 48-hour expiry |
| External (LDAP, OAuth, etc.) | WELCOMETOIREXTERNAL |
No — shows authentication source name |
The email is rendered in the user's configured language preference.
Example¶
Request (GET)¶
Request (POST)¶
POST /srv.asmx/SendWelcomeEmailForUser HTTP/1.1
Content-Type: application/x-www-form-urlencoded
authenticationTicket=abc123&userName=jdoe
Error Conditions¶
| Condition | Error Message |
|---|---|
| Caller is not a system administrator | Only the system administrator can perform this operation |
| User not found | User does not exist |
| User has no email address on file | User has no e-mail address on file |
Notes¶
- The password reset link embedded in native-account welcome emails expires after 48 hours.
- The SMTP server must be configured in
appsettings.jsonfor emails to be delivered.