Skip to content

authentication-emailAction

The following operations can be performed on "authentication-emailAction":

show| rm| set| add| unset|

show authentication emailAction

Displays information about all configured email actions, or displays detailed information about the specified action.

Synopsis

show authentication emailAction []

Arguments

name Name for the new email action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').

Output

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.

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.

devno count stateflag

Example

show authentication emailAction emailact

rm authentication emailAction

Deletes an existing email action.

Synopsis

rm authentication emailAction

Arguments

name Name for the new email action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my action').

Example

rm authentication emailAction emailact

set authentication emailAction

Modifies the specified attributes of an email action.

Synopsis

set authentication emailAction [-userName ] [-password ] [-serverURL ] [-content ] [-defaultAuthenticationGroup ] [-type ( SMTP | ATHENA )] [-emailAddress ]

Arguments

name Name for the new email action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my 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.

type Type of the email action. Default type is SMTP.

Possible values: SMTP, ATHENA Default value: 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.

Example

set authentication emailAction emailact -userName sender@example.com -password -serverURL "smtps://smtp.example.com:25" -content "OTP is $code" -emailAddress aaa.user.attribute("attrib2")

add authentication emailAction

Adds an email action that is used to send email to end users.

Synopsis

add authentication emailAction -userName -password -serverURL [-content ] [-defaultAuthenticationGroup ] [-type ( SMTP | ATHENA )] [-emailAddress ]

Arguments

name Name for the new email action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or 'my 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.

type Type of the email action. Default type is SMTP.

Possible values: SMTP, ATHENA Default value: 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.

Example

To send email containing OTP for authentication purpose using Secure SMTP server smtp.example.com with port 25, and sender email id is sender@example.com with expression: add authentication emailAction emailact -userName sender@example.com -password -serverURL "smtps://smtp.example.com:25" -content "OTP is $code" -emailAddress aaa.user.attribute("alternate_mail")

To send email containing OTP for authentication purpose using Secure SMTP server smtp.example.com with port 25, and sender email id is sender@example.com without expression (send to Default mail id): add authentication emailAction emailact -userName sender@example.com -password -serverURL "smtps://smtp.example.com:25" -content "OTP is $code"

unset authentication emailAction

Use this command to remove authentication emailAction settings.Refer to the set authentication emailAction command for meanings of the arguments.

Synopsis

unset authentication emailAction [-content] [-defaultAuthenticationGroup] [-type] [-emailAddress]

Was this article helpful?