EmailTemplateNode
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/EmailTemplateNode/1.0
Resource version: 3.0
create
Usage
am> create EmailTemplateNode --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" : { "emailTemplateName" : { "title" : "Email Template Name", "description" : "The IDM email template to be sent.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The attribute used to identify the the object in IDM.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute", "description" : "The IDM email field to send the email to.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" } }, "required" : [ "emailTemplateName", "identityAttribute", "emailAttribute" ] }
delete
Usage
am> delete EmailTemplateNode --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getType
List information related to the node such as a name, description, tags and metadata.
Usage
am> action EmailTemplateNode --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action EmailTemplateNode --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "The current configuration of the node type." } - --targetVersion
-
=== listOutcomes
List the available outcomes for the node type.
Usage
am> action EmailTemplateNode --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.", "type" : "object", "title" : "Node configuration" }
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query EmailTemplateNode --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read EmailTemplateNode --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update EmailTemplateNode --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" : { "emailTemplateName" : { "title" : "Email Template Name", "description" : "The IDM email template to be sent.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The attribute used to identify the the object in IDM.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute", "description" : "The IDM email field to send the email to.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" } }, "required" : [ "emailTemplateName", "identityAttribute", "emailAttribute" ] }