--- title: PushRegistration description: Resource path: component: pingam version: 8.1 page_id: pingam:entity-reference:sec-amster-entity-pushregistration canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-pushregistration.html llms_txt: https://docs.pingidentity.com/pingam/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md section_ids: sec-amster-entity-pushregistration-realm-ops: Realm Operations sec-amster-entity-pushregistration-realm-ops-create: create sec-amster-entity-pushregistration-realm-ops-delete: delete sec-amster-entity-pushregistration-realm-ops-gettype: getType sec-amster-entity-pushregistration-realm-ops-getupgradedconfig: getUpgradedConfig sec-amster-entity-pushregistration-realm-ops-query: query sec-amster-entity-pushregistration-realm-ops-read: read sec-amster-entity-pushregistration-realm-ops-update: update sec-amster-entity-pushregistration-realm-ops-versioninfo: versionInfo --- # PushRegistration ## Realm Operations Resource path: ``` /realm-config/authentication/authenticationtrees/nodes/PushRegistrationNode/1.0 ``` Resource version: `3.0` ### create **Usage** ``` am> create PushRegistration --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" : { "timeout" : { "title" : "Registration Response Timeout", "description" : "The period of time (in seconds) to wait for a response to the registration QR code. If no response is received during this time the QR code times out and the registration process fails.", "propertyOrder" : 70, "type" : "integer", "exampleValue" : "" }, "imgUrl" : { "title" : "Logo Image URL", "description" : "The location of an image to download and display as the issuer's logo within the ForgeRock Authenticator app.", "propertyOrder" : 40, "type" : "string", "exampleValue" : "" }, "issuer" : { "title" : "Issuer", "description" : "A value that appears as an identifier on the user's device. Common choices are a company name, a web site, or an AM realm.", "propertyOrder" : 10, "type" : "string", "exampleValue" : "" }, "generateRecoveryCodes" : { "title" : "Generate Recovery Codes", "description" : "If enabled, the success outcome's transient state will contain a set of recovery codes. If this success outcome is passed into a Recovery Code Display Node, these codes will be presented to the user. A user may use recovery codes to bypass the Push authentication node in the event they have lost their authenticator.", "propertyOrder" : 50, "type" : "boolean", "exampleValue" : "" }, "accountName" : { "title" : "Account Name", "description" : "This field allows select the user attribute to be used as the user's Account Name. It is used when the user's Push account is stored in the device. If left blank or the selected attribute is empty on user's profile, the account name will be set to the user's username.", "propertyOrder" : 20, "type" : "string", "exampleValue" : "" }, "bgColor" : { "title" : "Background Color", "description" : "The background color in hex notation to display behind the issuer's logo within the ForgeRock Authenticator app.", "propertyOrder" : 30, "type" : "string", "exampleValue" : "" }, "scanQRCodeMessage" : { "title" : "QR code message", "description" : "The message with instructions to scan the QR code for registering the device.", "propertyOrder" : 60, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "timeout", "imgUrl", "issuer", "generateRecoveryCodes", "accountName", "bgColor", "scanQRCodeMessage" ] } ``` ### delete **Usage** ``` am> delete PushRegistration --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 PushRegistration --realm Realm --actionName getType ``` ### getUpgradedConfig Get the upgraded configuration for the node type. **Usage** ``` am> action PushRegistration --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 PushRegistration --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 PushRegistration --realm Realm --filter filter ``` **Parameters** * *\--filter* A CREST formatted query filter, where "true" will query all. ### read **Usage** ``` am> read PushRegistration --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### update **Usage** ``` am> update PushRegistration --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" : { "timeout" : { "title" : "Registration Response Timeout", "description" : "The period of time (in seconds) to wait for a response to the registration QR code. If no response is received during this time the QR code times out and the registration process fails.", "propertyOrder" : 70, "type" : "integer", "exampleValue" : "" }, "imgUrl" : { "title" : "Logo Image URL", "description" : "The location of an image to download and display as the issuer's logo within the ForgeRock Authenticator app.", "propertyOrder" : 40, "type" : "string", "exampleValue" : "" }, "issuer" : { "title" : "Issuer", "description" : "A value that appears as an identifier on the user's device. Common choices are a company name, a web site, or an AM realm.", "propertyOrder" : 10, "type" : "string", "exampleValue" : "" }, "generateRecoveryCodes" : { "title" : "Generate Recovery Codes", "description" : "If enabled, the success outcome's transient state will contain a set of recovery codes. If this success outcome is passed into a Recovery Code Display Node, these codes will be presented to the user. A user may use recovery codes to bypass the Push authentication node in the event they have lost their authenticator.", "propertyOrder" : 50, "type" : "boolean", "exampleValue" : "" }, "accountName" : { "title" : "Account Name", "description" : "This field allows select the user attribute to be used as the user's Account Name. It is used when the user's Push account is stored in the device. If left blank or the selected attribute is empty on user's profile, the account name will be set to the user's username.", "propertyOrder" : 20, "type" : "string", "exampleValue" : "" }, "bgColor" : { "title" : "Background Color", "description" : "The background color in hex notation to display behind the issuer's logo within the ForgeRock Authenticator app.", "propertyOrder" : 30, "type" : "string", "exampleValue" : "" }, "scanQRCodeMessage" : { "title" : "QR code message", "description" : "The message with instructions to scan the QR code for registering the device.", "propertyOrder" : 60, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "timeout", "imgUrl", "issuer", "generateRecoveryCodes", "accountName", "bgColor", "scanQRCodeMessage" ] } ``` ### versionInfo List the versions available for the node type. **Usage** ``` am> action PushRegistration --realm Realm --actionName versionInfo ```