--- title: PushSender description: Resource path: component: pingam version: 8.1 page_id: pingam:entity-reference:sec-amster-entity-pushsender canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-pushsender.html section_ids: sec-amster-entity-pushsender-realm-ops: Realm Operations sec-amster-entity-pushsender-realm-ops-create: create sec-amster-entity-pushsender-realm-ops-delete: delete sec-amster-entity-pushsender-realm-ops-gettype: getType sec-amster-entity-pushsender-realm-ops-getupgradedconfig: getUpgradedConfig sec-amster-entity-pushsender-realm-ops-query: query sec-amster-entity-pushsender-realm-ops-read: read sec-amster-entity-pushsender-realm-ops-update: update sec-amster-entity-pushsender-realm-ops-versioninfo: versionInfo --- # PushSender ## Realm Operations Resource path: ``` /realm-config/authentication/authenticationtrees/nodes/PushAuthenticationSenderNode/1.0 ``` Resource version: `3.0` ### create **Usage** ``` am> create PushSender --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: ```json { "type" : "object", "properties" : { "userMessage" : { "title" : "User Message", "description" : "The message to send to the user. {{user}} and {{issuer}} may be used as replacements for the username and issuer name respectively.", "propertyOrder" : 200, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "mandatory" : { "title" : "Remove 'skip' option", "description" : "If checked, users will no longer be able to skip the module, and must interact with it.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "contextInfo" : { "title" : "Share Context Info", "description" : "If checked, additional context information will be added into the notification. The data contains remoteIp, userAgent, and location. Note that the location attribute requires the presence of Device Profile Collector node in the Tree with 'Collect Device Location' config enabled.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "customPayload" : { "title" : "Custom Payload Attributes", "description" : "Shared state objects which will be included in the message payload sent to the client. Maximum payload for both iOS and Android is 3KB.", "propertyOrder" : 500, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, failure to send the Push Notification is captured in shared state for use by subsequent nodes in the journey.", "propertyOrder" : 700, "type" : "boolean", "exampleValue" : "" }, "pushType" : { "title" : "Push Type", "description" : "This field allows selection of the Push notification type. The 'Tap to Accept' is the default notification type, it just requires the user to Accept it. The 'Display Challenge Code' requires the user to enter the matching code on the user's device before processing the notification. The 'Use Biometrics to Accept' requires local Biometric authentication to process the notification.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "messageTimeout" : { "title" : "Message Timeout", "description" : "The duration (in ms) that the message will time out after.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" } }, "required" : [ "userMessage", "mandatory", "contextInfo", "customPayload", "captureFailure", "pushType", "messageTimeout" ] } ``` ### delete **Usage** ``` am> delete PushSender --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 PushSender --realm Realm --actionName getType ``` ### getUpgradedConfig Get the upgraded configuration for the node type. **Usage** ``` am> action PushSender --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "title" : "The current configuration of the node type." } ``` * *\--targetVersion* \=== listOutcomes List the available outcomes for the node type. **Usage** ``` am> action PushSender --realm Realm --body body --actionName listOutcomes ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "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 PushSender --realm Realm --filter filter ``` **Parameters** * *\--filter* A CREST formatted query filter, where "true" will query all. ### read **Usage** ``` am> read PushSender --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### update **Usage** ``` am> update PushSender --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: ```json { "type" : "object", "properties" : { "userMessage" : { "title" : "User Message", "description" : "The message to send to the user. {{user}} and {{issuer}} may be used as replacements for the username and issuer name respectively.", "propertyOrder" : 200, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "mandatory" : { "title" : "Remove 'skip' option", "description" : "If checked, users will no longer be able to skip the module, and must interact with it.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "contextInfo" : { "title" : "Share Context Info", "description" : "If checked, additional context information will be added into the notification. The data contains remoteIp, userAgent, and location. Note that the location attribute requires the presence of Device Profile Collector node in the Tree with 'Collect Device Location' config enabled.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "customPayload" : { "title" : "Custom Payload Attributes", "description" : "Shared state objects which will be included in the message payload sent to the client. Maximum payload for both iOS and Android is 3KB.", "propertyOrder" : 500, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, failure to send the Push Notification is captured in shared state for use by subsequent nodes in the journey.", "propertyOrder" : 700, "type" : "boolean", "exampleValue" : "" }, "pushType" : { "title" : "Push Type", "description" : "This field allows selection of the Push notification type. The 'Tap to Accept' is the default notification type, it just requires the user to Accept it. The 'Display Challenge Code' requires the user to enter the matching code on the user's device before processing the notification. The 'Use Biometrics to Accept' requires local Biometric authentication to process the notification.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "messageTimeout" : { "title" : "Message Timeout", "description" : "The duration (in ms) that the message will time out after.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" } }, "required" : [ "userMessage", "mandatory", "contextInfo", "customPayload", "captureFailure", "pushType", "messageTimeout" ] } ``` ### versionInfo List the versions available for the node type. **Usage** ``` am> action PushSender --realm Realm --actionName versionInfo ```