OTPEmailSender
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/OneTimePasswordSmtpSenderNode
Resource version: 1.0
create
Usage
am> create OTPEmailSender --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "emailSubject" : { "title" : "The subject of the email", "description" : "This is the subject of the email that will be sent.", "propertyOrder" : 1300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "password" : { "title" : "Mail Server Authentication Password", "description" : "The password to use when the mail server is using SMTP authentication.", "propertyOrder" : 500, "type" : "string", "format" : "password", "exampleValue" : "" }, "username" : { "title" : "Mail Server Authentication Username", "description" : "The username to use when the mail server is using SMTP authentication.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "smsGatewayImplementationClass" : { "title" : "Gateway Implementation Class", "description" : "The OTP Email Sender node uses this class to send email messages. <br><br>The gateway class must implement the following interface: <br><code>com.sun.identity.authentication.modules.hotp.SMSGateway</code>", "propertyOrder" : 2200, "type" : "string", "exampleValue" : "" }, "hostName" : { "title" : "Mail Server Host Name", "description" : "The name of the mail server OpenAM will use to send the messages.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "fromEmailAddress" : { "title" : "Email From Address", "description" : "Emails from the OTP Email Sender node will come from this address.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute Name", "description" : "This is the attribute name used by the OTP Sender to email the user.", "propertyOrder" : 1100, "type" : "string", "exampleValue" : "" }, "hostPort" : { "title" : "Mail Server Host Port", "description" : "The port of the mail server. The default port for SMTP is 25, if using SSL the default port is 465.", "propertyOrder" : 300, "type" : "integer", "exampleValue" : "" }, "sslOption" : { "title" : "Mail Server Secure Connection", "description" : "This setting controls whether the authentication module communicates with the mail server using SSL/TLS.", "propertyOrder" : 2100, "type" : "string", "exampleValue" : "" }, "emailContent" : { "title" : "The content of the email", "description" : "This is the content of the email that will be sent. All occurrence of {{OTP}} will be replaced with the One Time Password.", "propertyOrder" : 1400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "username", "hostName", "sslOption", "smsGatewayImplementationClass", "hostPort", "emailAttribute", "emailContent", "fromEmailAddress", "emailSubject" ] }
delete
Usage
am> delete OTPEmailSender --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action OTPEmailSender --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action OTPEmailSender --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action OTPEmailSender --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "Some configuration of the node. This does not need to be complete against the configuration schema." }
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action OTPEmailSender --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query OTPEmailSender --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read OTPEmailSender --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update OTPEmailSender --realm Realm --id id --body body
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "properties" : { "emailSubject" : { "title" : "The subject of the email", "description" : "This is the subject of the email that will be sent.", "propertyOrder" : 1300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "password" : { "title" : "Mail Server Authentication Password", "description" : "The password to use when the mail server is using SMTP authentication.", "propertyOrder" : 500, "type" : "string", "format" : "password", "exampleValue" : "" }, "username" : { "title" : "Mail Server Authentication Username", "description" : "The username to use when the mail server is using SMTP authentication.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "smsGatewayImplementationClass" : { "title" : "Gateway Implementation Class", "description" : "The OTP Email Sender node uses this class to send email messages. <br><br>The gateway class must implement the following interface: <br><code>com.sun.identity.authentication.modules.hotp.SMSGateway</code>", "propertyOrder" : 2200, "type" : "string", "exampleValue" : "" }, "hostName" : { "title" : "Mail Server Host Name", "description" : "The name of the mail server OpenAM will use to send the messages.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "fromEmailAddress" : { "title" : "Email From Address", "description" : "Emails from the OTP Email Sender node will come from this address.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute Name", "description" : "This is the attribute name used by the OTP Sender to email the user.", "propertyOrder" : 1100, "type" : "string", "exampleValue" : "" }, "hostPort" : { "title" : "Mail Server Host Port", "description" : "The port of the mail server. The default port for SMTP is 25, if using SSL the default port is 465.", "propertyOrder" : 300, "type" : "integer", "exampleValue" : "" }, "sslOption" : { "title" : "Mail Server Secure Connection", "description" : "This setting controls whether the authentication module communicates with the mail server using SSL/TLS.", "propertyOrder" : 2100, "type" : "string", "exampleValue" : "" }, "emailContent" : { "title" : "The content of the email", "description" : "This is the content of the email that will be sent. All occurrence of {{OTP}} will be replaced with the One Time Password.", "propertyOrder" : 1400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "username", "hostName", "sslOption", "smsGatewayImplementationClass", "hostPort", "emailAttribute", "emailContent", "fromEmailAddress", "emailSubject" ] }