PingOneIdentityMatch
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/PingOneIdentityMatchNode
Resource version: 2.0
create
Usage
am> create PingOneIdentityMatch --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" : { "pingIdentityAttribute" : { "title" : "PingOne identity attribute", "description" : "The PingOne user attribute to be used for matching the AM user. If this attribute identifies more than one user with the same value in the PingOne system, it will fail.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, a failure is captured in shared state under a keynamed <code>pingOneIdentityMatchFailureReason</code> for use by subsequent nodes in the journey.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "amIdentityAttribute" : { "title" : "AM identity attribute", "description" : "The attribute of the existing AM identity object that will be used to query the PingOne user. If there are multiple entries with the same attribute value in the PingOne directory server, ensure that this property is specific enough to retrieve only one entry.", "propertyOrder" : 200, "type" : "string", "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" : [ "pingIdentityAttribute", "captureFailure", "amIdentityAttribute", "pingOneWorker" ] }
delete
Usage
am> delete PingOneIdentityMatch --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action PingOneIdentityMatch --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action PingOneIdentityMatch --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action PingOneIdentityMatch --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "Some configuration of the node. This does not need to be complete against the configuration schema." }
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action PingOneIdentityMatch --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query PingOneIdentityMatch --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PingOneIdentityMatch --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PingOneIdentityMatch --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" : { "pingIdentityAttribute" : { "title" : "PingOne identity attribute", "description" : "The PingOne user attribute to be used for matching the AM user. If this attribute identifies more than one user with the same value in the PingOne system, it will fail.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "captureFailure" : { "title" : "Capture failure", "description" : "If selected, a failure is captured in shared state under a keynamed <code>pingOneIdentityMatchFailureReason</code> for use by subsequent nodes in the journey.", "propertyOrder" : 400, "type" : "boolean", "exampleValue" : "" }, "amIdentityAttribute" : { "title" : "AM identity attribute", "description" : "The attribute of the existing AM identity object that will be used to query the PingOne user. If there are multiple entries with the same attribute value in the PingOne directory server, ensure that this property is specific enough to retrieve only one entry.", "propertyOrder" : 200, "type" : "string", "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" : [ "pingIdentityAttribute", "captureFailure", "amIdentityAttribute", "pingOneWorker" ] }