PingOneCreateUser
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/PingOneCreateUserNode/1.0
Resource version: 3.0
create
Usage
am> create PingOneCreateUser --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" : { "populationId" : { "title" : "Population ID", "description" : "The unique identifier for the PingOne population.<br><br>If not specified, the node uses the environment's default population.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "amIdentityAttribute" : { "title" : "AM identity attribute", "description" : "The attribute of the existing AM identity object that will be used as key to identity the user in the PingOne directory server.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "anonymizedUser" : { "title" : "Anonymized user", "description" : "Whether to create the anonymized PingOne user.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneCreateUserFailureReason</code> for use by subsequent nodes in the journey.", "propertyOrder" : 500, "type" : "boolean", "exampleValue" : "" }, "pingOneWorker" : { "title" : "PingOne Worker service ID", "description" : "The ID of the PingOne Worker service for connecting to PingOne.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "populationId", "amIdentityAttribute", "anonymizedUser", "captureFailure", "pingOneWorker" ] }
delete
Usage
am> delete PingOneCreateUser --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 PingOneCreateUser --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action PingOneCreateUser --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "The current configuration of the node type." } - --targetVersion
-
=== listOutcomes
List the available outcomes for the node type.
Usage
am> action PingOneCreateUser --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "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 PingOneCreateUser --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PingOneCreateUser --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PingOneCreateUser --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" : { "populationId" : { "title" : "Population ID", "description" : "The unique identifier for the PingOne population.<br><br>If not specified, the node uses the environment's default population.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "amIdentityAttribute" : { "title" : "AM identity attribute", "description" : "The attribute of the existing AM identity object that will be used as key to identity the user in the PingOne directory server.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "anonymizedUser" : { "title" : "Anonymized user", "description" : "Whether to create the anonymized PingOne user.", "propertyOrder" : 300, "type" : "boolean", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneCreateUserFailureReason</code> for use by subsequent nodes in the journey.", "propertyOrder" : 500, "type" : "boolean", "exampleValue" : "" }, "pingOneWorker" : { "title" : "PingOne Worker service ID", "description" : "The ID of the PingOne Worker service for connecting to PingOne.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "populationId", "amIdentityAttribute", "anonymizedUser", "captureFailure", "pingOneWorker" ] }