PingAM

SetSuccessDetails

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/SetSuccessDetailsNode/1.0

Resource version: 3.0

create

Usage

am> create SetSuccessDetails --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" : {
    "sessionProperties" : {
      "title" : "Session Properties",
      "description" : "Session properties map to add to response body when authentication succeeds. This is similar to Success Details except that the values must be keys that are present in the session as properties. The keys will be mapped to values and added to the response body. If the property is not present in the session, it will not be added to the response body.",
      "propertyOrder" : 200,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "headerControl" : {
      "title" : "Response Headers",
      "description" : "The headers to set on the response when authentication succeeds.",
      "propertyOrder" : 300,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "successDetails" : {
      "title" : "Success Details",
      "description" : "The static details to add to the response body when authentication succeeds.",
      "propertyOrder" : 100,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    }
  },
  "required" : [ "sessionProperties", "headerControl", "successDetails" ]
}

delete

Usage

am> delete SetSuccessDetails --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 SetSuccessDetails --realm Realm --actionName getType

getUpgradedConfig

Get the upgraded configuration for the node type.

Usage

am> action SetSuccessDetails --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 SetSuccessDetails --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 SetSuccessDetails --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read SetSuccessDetails --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update SetSuccessDetails --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" : {
    "sessionProperties" : {
      "title" : "Session Properties",
      "description" : "Session properties map to add to response body when authentication succeeds. This is similar to Success Details except that the values must be keys that are present in the session as properties. The keys will be mapped to values and added to the response body. If the property is not present in the session, it will not be added to the response body.",
      "propertyOrder" : 200,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "headerControl" : {
      "title" : "Response Headers",
      "description" : "The headers to set on the response when authentication succeeds.",
      "propertyOrder" : 300,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "successDetails" : {
      "title" : "Success Details",
      "description" : "The static details to add to the response body when authentication succeeds.",
      "propertyOrder" : 100,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    }
  },
  "required" : [ "sessionProperties", "headerControl", "successDetails" ]
}

versionInfo

List the versions available for the node type.

Usage

am> action SetSuccessDetails --realm Realm --actionName versionInfo