| getauthenticationemailactionResult Structure Definition |
The getauthenticationemailactionResult structure defines the return type for getauthenticationemailaction API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
authenticationemailactionList |
List of authenticationemailactions |
| authenticationemailaction Structure Definition |
The authenticationemailaction structure defines the actual return type values for getauthenticationemailaction API. |
Syntax |
Members |
name |
Name for the new email action. |
username |
Username/Clientid/EmailID to be used to authenticate to the server. |
password |
Password/Clientsecret to use when authenticating to the server. |
serverurl |
Address of the server that delivers the message. It is fully qualified fqdn such as http(s):// or smtp(s):// for http and smtp protocols respectively. For SMTP, the port number is mandatory like smtps://smtp.example.com:25. |
content |
Content to be delivered to the user. "$code" string within the content will be replaced with the actual one-time-code to be sent. |
defaultauthenticationgroup |
This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust. |
timeout |
Time after which the code expires. NOTE: This attribute is deprecated. This attribute is deprecated and configuring it will have no effect. |
type |
Type of the email action. Default type is SMTP. |
emailaddress |
An optional expression that yields user's email. When not configured, user's default mail address would be used. When configured, result of this expression is used as destination email address. |
_nextgenapiresource |
See Also |