Skip to content

authentication emailAction

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

add| rm| set| unset| show

add authentication emailAction

p{white-space: pre-wrap;}

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

Synopsys

add authentication emailAction <name> -userName <string> -password -serverURL <string> [-content <string>] [-defaultAuthenticationGroup <string>] [-timeout <positive_integer>] [-type ( SMTP | ATHENA )] [-emailAddress <string>]

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.

timeout

Time after which the code expires.

Default value: 30

Minimum value: 0

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 <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 <Password> -serverURL "smtps://smtp.example.com:25" -content "OTP is $code"

rm authentication emailAction

p{white-space: pre-wrap;}

Deletes an existing email action.

Synopsys

rm authentication emailAction <name>

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

p{white-space: pre-wrap;}

Modifies the specified attributes of an email action.

Synopsys

set authentication emailAction <name> [-userName <string>] [-password ] [-serverURL <string>] [-content <string>] [-defaultAuthenticationGroup <string>] [-timeout <positive_integer>] [-type ( SMTP | ATHENA )] [-emailAddress <string>]

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.

timeout

Time after which the code expires.

Default value: 30

Minimum value: 0

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 <Password> -serverURL "smtps://smtp.example.com:25" -content "OTP is $code" -emailAddress aaa.user.attribute("attrib2")

unset authentication emailAction

p{white-space: pre-wrap;}

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

Synopsys

unset authentication emailAction <name> [-content] [-defaultAuthenticationGroup] [-timeout] [-type] [-emailAddress]

show authentication emailAction

p{white-space: pre-wrap;}

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

Synopsys

show authentication emailAction [<name>]

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').

Outputs

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