EmailSuspendNode
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/EmailSuspendNode
Resource version: 1.0
create
Usage
am> create EmailSuspendNode --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" : { "emailSuspendMessage" : { "title" : "Email Suspend Message", "description" : "The localised message to be returned once the tree is suspended.", "propertyOrder" : 300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "objectLookup" : { "title" : "Object Lookup", "description" : "Determines whether object lookup should occur. If true, existing object is queried. Otherwise, object in shared state is used for template object.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute", "description" : "The IDM email field to send the email to.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The attribute used to identify the the object in IDM.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" }, "emailTemplateName" : { "title" : "Email Template Name", "description" : "The IDM email template to be sent.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "emailSuspendMessage", "objectLookup", "emailAttribute", "identityAttribute", "emailTemplateName" ] }
delete
Usage
am> delete EmailSuspendNode --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 EmailSuspendNode --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action EmailSuspendNode --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action EmailSuspendNode --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 EmailSuspendNode --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query EmailSuspendNode --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read EmailSuspendNode --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update EmailSuspendNode --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" : { "emailSuspendMessage" : { "title" : "Email Suspend Message", "description" : "The localised message to be returned once the tree is suspended.", "propertyOrder" : 300, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "objectLookup" : { "title" : "Object Lookup", "description" : "Determines whether object lookup should occur. If true, existing object is queried. Otherwise, object in shared state is used for template object.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "emailAttribute" : { "title" : "Email Attribute", "description" : "The IDM email field to send the email to.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The attribute used to identify the the object in IDM.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" }, "emailTemplateName" : { "title" : "Email Template Name", "description" : "The IDM email template to be sent.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "emailSuspendMessage", "objectLookup", "emailAttribute", "identityAttribute", "emailTemplateName" ] }