--- title: PushNotification description: Resource path: component: pingam version: 8.1 page_id: pingam:entity-reference:sec-amster-entity-pushnotification canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-pushnotification.html section_ids: sec-amster-entity-pushnotification-realm-ops: Realm Operations sec-amster-entity-pushnotification-realm-ops-create: create sec-amster-entity-pushnotification-realm-ops-delete: delete sec-amster-entity-pushnotification-realm-ops-getalltypes: getAllTypes sec-amster-entity-pushnotification-realm-ops-getcreatabletypes: getCreatableTypes sec-amster-entity-pushnotification-realm-ops-nextdescendents: nextdescendents sec-amster-entity-pushnotification-realm-ops-read: read sec-amster-entity-pushnotification-realm-ops-update: update sec-amster-entity-pushnotification-global-ops: Global Operations sec-amster-entity-pushnotification-global-ops-getalltypes: getAllTypes sec-amster-entity-pushnotification-global-ops-getcreatabletypes: getCreatableTypes sec-amster-entity-pushnotification-global-ops-nextdescendents: nextdescendents sec-amster-entity-pushnotification-global-ops-read: read sec-amster-entity-pushnotification-global-ops-update: update --- # PushNotification ## Realm Operations Resource path: ``` /realm-config/services/pushNotification ``` Resource version: `0.0` ### create **Usage** ``` am> create PushNotification --realm Realm --body body ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "mdDuration" : { "title" : "Response Cache Duration", "description" : "The minimum lifetime to keep unanswered message records in the message dispatcher cache, in seconds. To keep unanswered message records indefinitely, set this property to 0.Should be tuned so that it is applicable to the use case of this service. For example, the ForgeRock Authenticator (Push) authentication module has a default timeout of 120 seconds.", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" }, "region" : { "title" : "SNS Client Region", "description" : "Region of your registered Amazon Simple Notification Service client. For more information, see https://docs.aws.amazon.com/general/latest/gr/rande.html.", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "accessKey" : { "title" : "SNS Access Key ID", "description" : "Amazon Simple Notification Service Access Key ID. For more information, refer to ForgeRock Knowledge Base.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "AKIAIOSFODNN7EXAMPLE" }, "delegateFactory" : { "title" : "Message Transport Delegate Factory", "description" : "The fully qualified class name of the factory responsible for creating the PushNotificationDelegate. The class must implement org.forgerock.openam.services.push.PushNotificationDelegate.", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "mdConcurrency" : { "title" : "Response Cache Concurrency", "description" : "Level of concurrency to use when accessing the message dispatcher cache. Defaults to 16, and must be greater than 0. Choose a value to accommodate as many threads as will ever concurrently access the message dispatcher cache.", "propertyOrder" : 800, "required" : true, "type" : "integer", "exampleValue" : "" }, "googleEndpoint" : { "title" : "SNS Endpoint for GCM", "description" : "The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages over Google Cloud Messaging (GCM).", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "arn:aws:sns:us-east-1:1234567890:app/GCM/production" }, "mdCacheSize" : { "title" : "Response Cache Size", "description" : "Maximum size of the message dispatcher cache, in number of records. If set to 0 the cache can grow indefinitely. If the number of records that need to be stored exceeds this maximum, then older items in the cache will be removed to make space.", "propertyOrder" : 900, "required" : true, "type" : "integer", "exampleValue" : "" }, "appleEndpoint" : { "title" : "SNS Endpoint for APNS", "description" : "The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages to the Apple Push Notification Service (APNS).", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "arn:aws:sns:us-east-1:1234567890:app/APNS/production" }, "secret" : { "title" : "SNS Access Key Secret", "description" : "Amazon Simple Notification Service Access Key Secret. For more information, refer to ForgeRock Knowledge Base.
Note:This value is ignored if you map the secret label am.services.pushnotification.sns.accesskey.secret to a secret in a secret store.", "propertyOrder" : 200, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" } } } ``` ### delete **Usage** ``` am> delete PushNotification --realm Realm ``` ### getAllTypes Obtain the collection of all secondary configuration types related to the resource. **Usage** ``` am> action PushNotification --realm Realm --actionName getAllTypes ``` ### getCreatableTypes Obtain the collection of secondary configuration types that have yet to be added to the resource. **Usage** ``` am> action PushNotification --realm Realm --actionName getCreatableTypes ``` ### nextdescendents Obtain the collection of secondary configuration instances that have been added to the resource. **Usage** ``` am> action PushNotification --realm Realm --actionName nextdescendents ``` ### read **Usage** ``` am> read PushNotification --realm Realm ``` ### update **Usage** ``` am> update PushNotification --realm Realm --body body ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "mdDuration" : { "title" : "Response Cache Duration", "description" : "The minimum lifetime to keep unanswered message records in the message dispatcher cache, in seconds. To keep unanswered message records indefinitely, set this property to 0.Should be tuned so that it is applicable to the use case of this service. For example, the ForgeRock Authenticator (Push) authentication module has a default timeout of 120 seconds.", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" }, "region" : { "title" : "SNS Client Region", "description" : "Region of your registered Amazon Simple Notification Service client. For more information, see https://docs.aws.amazon.com/general/latest/gr/rande.html.", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "accessKey" : { "title" : "SNS Access Key ID", "description" : "Amazon Simple Notification Service Access Key ID. For more information, refer to ForgeRock Knowledge Base.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "AKIAIOSFODNN7EXAMPLE" }, "delegateFactory" : { "title" : "Message Transport Delegate Factory", "description" : "The fully qualified class name of the factory responsible for creating the PushNotificationDelegate. The class must implement org.forgerock.openam.services.push.PushNotificationDelegate.", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "mdConcurrency" : { "title" : "Response Cache Concurrency", "description" : "Level of concurrency to use when accessing the message dispatcher cache. Defaults to 16, and must be greater than 0. Choose a value to accommodate as many threads as will ever concurrently access the message dispatcher cache.", "propertyOrder" : 800, "required" : true, "type" : "integer", "exampleValue" : "" }, "googleEndpoint" : { "title" : "SNS Endpoint for GCM", "description" : "The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages over Google Cloud Messaging (GCM).", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "arn:aws:sns:us-east-1:1234567890:app/GCM/production" }, "mdCacheSize" : { "title" : "Response Cache Size", "description" : "Maximum size of the message dispatcher cache, in number of records. If set to 0 the cache can grow indefinitely. If the number of records that need to be stored exceeds this maximum, then older items in the cache will be removed to make space.", "propertyOrder" : 900, "required" : true, "type" : "integer", "exampleValue" : "" }, "appleEndpoint" : { "title" : "SNS Endpoint for APNS", "description" : "The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages to the Apple Push Notification Service (APNS).", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "arn:aws:sns:us-east-1:1234567890:app/APNS/production" }, "secret" : { "title" : "SNS Access Key Secret", "description" : "Amazon Simple Notification Service Access Key Secret. For more information, refer to ForgeRock Knowledge Base.
Note:This value is ignored if you map the secret label am.services.pushnotification.sns.accesskey.secret to a secret in a secret store.", "propertyOrder" : 200, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" } } } ``` ## Global Operations Resource path: ``` /global-config/services/pushNotification ``` Resource version: `1.0` ### getAllTypes Obtain the collection of all secondary configuration types related to the resource. **Usage** ``` am> action PushNotification --global --actionName getAllTypes ``` ### getCreatableTypes Obtain the collection of secondary configuration types that have yet to be added to the resource. **Usage** ``` am> action PushNotification --global --actionName getCreatableTypes ``` ### nextdescendents Obtain the collection of secondary configuration instances that have been added to the resource. **Usage** ``` am> action PushNotification --global --actionName nextdescendents ``` ### read **Usage** ``` am> read PushNotification --global ``` ### update **Usage** ``` am> update PushNotification --global --body body ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "defaults" : { "properties" : { "mdCacheSize" : { "title" : "Response Cache Size", "description" : "Maximum size of the message dispatcher cache, in number of records. If set to 0 the cache can grow indefinitely. If the number of records that need to be stored exceeds this maximum, then older items in the cache will be removed to make space.", "propertyOrder" : 900, "required" : true, "type" : "integer", "exampleValue" : "" }, "accessKey" : { "title" : "SNS Access Key ID", "description" : "Amazon Simple Notification Service Access Key ID. For more information, refer to ForgeRock Knowledge Base.", "propertyOrder" : 100, "required" : true, "type" : "string", "exampleValue" : "AKIAIOSFODNN7EXAMPLE" }, "mdConcurrency" : { "title" : "Response Cache Concurrency", "description" : "Level of concurrency to use when accessing the message dispatcher cache. Defaults to 16, and must be greater than 0. Choose a value to accommodate as many threads as will ever concurrently access the message dispatcher cache.", "propertyOrder" : 800, "required" : true, "type" : "integer", "exampleValue" : "" }, "appleEndpoint" : { "title" : "SNS Endpoint for APNS", "description" : "The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages to the Apple Push Notification Service (APNS).", "propertyOrder" : 300, "required" : true, "type" : "string", "exampleValue" : "arn:aws:sns:us-east-1:1234567890:app/APNS/production" }, "delegateFactory" : { "title" : "Message Transport Delegate Factory", "description" : "The fully qualified class name of the factory responsible for creating the PushNotificationDelegate. The class must implement org.forgerock.openam.services.push.PushNotificationDelegate.", "propertyOrder" : 600, "required" : true, "type" : "string", "exampleValue" : "" }, "region" : { "title" : "SNS Client Region", "description" : "Region of your registered Amazon Simple Notification Service client. For more information, see https://docs.aws.amazon.com/general/latest/gr/rande.html.", "propertyOrder" : 500, "required" : true, "type" : "string", "exampleValue" : "" }, "secret" : { "title" : "SNS Access Key Secret", "description" : "Amazon Simple Notification Service Access Key Secret. For more information, refer to ForgeRock Knowledge Base.
Note:This value is ignored if you map the secret label am.services.pushnotification.sns.accesskey.secret to a secret in a secret store.", "propertyOrder" : 200, "required" : true, "type" : "string", "format" : "password", "exampleValue" : "" }, "googleEndpoint" : { "title" : "SNS Endpoint for GCM", "description" : "The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages over Google Cloud Messaging (GCM).", "propertyOrder" : 400, "required" : true, "type" : "string", "exampleValue" : "arn:aws:sns:us-east-1:1234567890:app/GCM/production" }, "mdDuration" : { "title" : "Response Cache Duration", "description" : "The minimum lifetime to keep unanswered message records in the message dispatcher cache, in seconds. To keep unanswered message records indefinitely, set this property to 0.Should be tuned so that it is applicable to the use case of this service. For example, the ForgeRock Authenticator (Push) authentication module has a default timeout of 120 seconds.", "propertyOrder" : 700, "required" : true, "type" : "integer", "exampleValue" : "" } }, "type" : "object", "title" : "Realm Defaults" } } } ```