--- title: BackchannelInitialize description: Resource path: component: pingam version: 8.1 page_id: pingam:entity-reference:sec-amster-entity-backchannelinitialize canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-backchannelinitialize.html section_ids: sec-amster-entity-backchannelinitialize-realm-ops: Realm Operations sec-amster-entity-backchannelinitialize-realm-ops-create: create sec-amster-entity-backchannelinitialize-realm-ops-delete: delete sec-amster-entity-backchannelinitialize-realm-ops-gettype: getType sec-amster-entity-backchannelinitialize-realm-ops-getupgradedconfig: getUpgradedConfig sec-amster-entity-backchannelinitialize-realm-ops-query: query sec-amster-entity-backchannelinitialize-realm-ops-read: read sec-amster-entity-backchannelinitialize-realm-ops-update: update sec-amster-entity-backchannelinitialize-realm-ops-versioninfo: versionInfo --- # BackchannelInitialize ## Realm Operations Resource path: ``` /realm-config/authentication/authenticationtrees/nodes/BackChannelInitNode/1.0 ``` Resource version: `3.0` ### create **Usage** ``` am> create BackchannelInitialize --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" : { "idType" : { "title" : "Subject Type", "description" : "The type of subject (User or Agent) to initialize the journey for. If None, any subject can log in using the generated journey.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "timeout" : { "title" : "Max Time (Seconds)", "description" : "The number of seconds to wait for the backchannel journey to complete before timing out. If you don't set this, AM uses the default transaction timeout for the realm.", "propertyOrder" : 900, "type" : "integer", "exampleValue" : "" }, "usernameKey" : { "title" : "Subject Name Key", "description" : "The node state key that contains the user ID of the subject to initialize the journey for. This property is ignored if Subject Type is None.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "tree" : { "title" : "Journey", "description" : "The journey to initialize.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "allowRetry" : { "title" : "Allow Retry", "description" : "If true, the end user can retry the backchannel journey if it fails. There's no maximum _number_ of retries, but the retry window ends after the `Max Time`.", "propertyOrder" : 1000, "type" : "boolean", "exampleValue" : "" }, "dataKey" : { "title" : "Data Object Key", "description" : "The node state key that contains the data object (if present) to pass to the journey at the root level of shared state.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" }, "redirectUrlType" : { "title" : "Redirect URL Type", "description" : "The type of redirect URL to save to node state.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "customRedirectUrl" : { "title" : "Custom Redirect URL", "description" : "The custom redirect URL to save to node state. This property is only taken into account if Redirect URL Type is Custom.", "propertyOrder" : 800, "type" : "string", "exampleValue" : "" } }, "required" : [ "idType", "tree", "allowRetry", "redirectUrlType" ] } ``` ### delete **Usage** ``` am> delete BackchannelInitialize --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 BackchannelInitialize --realm Realm --actionName getType ``` ### getUpgradedConfig Get the upgraded configuration for the node type. **Usage** ``` am> action BackchannelInitialize --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 BackchannelInitialize --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 BackchannelInitialize --realm Realm --filter filter ``` **Parameters** * *\--filter* A CREST formatted query filter, where "true" will query all. ### read **Usage** ``` am> read BackchannelInitialize --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### update **Usage** ``` am> update BackchannelInitialize --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" : { "idType" : { "title" : "Subject Type", "description" : "The type of subject (User or Agent) to initialize the journey for. If None, any subject can log in using the generated journey.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "timeout" : { "title" : "Max Time (Seconds)", "description" : "The number of seconds to wait for the backchannel journey to complete before timing out. If you don't set this, AM uses the default transaction timeout for the realm.", "propertyOrder" : 900, "type" : "integer", "exampleValue" : "" }, "usernameKey" : { "title" : "Subject Name Key", "description" : "The node state key that contains the user ID of the subject to initialize the journey for. This property is ignored if Subject Type is None.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "tree" : { "title" : "Journey", "description" : "The journey to initialize.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "allowRetry" : { "title" : "Allow Retry", "description" : "If true, the end user can retry the backchannel journey if it fails. There's no maximum _number_ of retries, but the retry window ends after the `Max Time`.", "propertyOrder" : 1000, "type" : "boolean", "exampleValue" : "" }, "dataKey" : { "title" : "Data Object Key", "description" : "The node state key that contains the data object (if present) to pass to the journey at the root level of shared state.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" }, "redirectUrlType" : { "title" : "Redirect URL Type", "description" : "The type of redirect URL to save to node state.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "customRedirectUrl" : { "title" : "Custom Redirect URL", "description" : "The custom redirect URL to save to node state. This property is only taken into account if Redirect URL Type is Custom.", "propertyOrder" : 800, "type" : "string", "exampleValue" : "" } }, "required" : [ "idType", "tree", "allowRetry", "redirectUrlType" ] } ``` ### versionInfo List the versions available for the node type. **Usage** ``` am> action BackchannelInitialize --realm Realm --actionName versionInfo ```