---
title: SetSuccessDetails
description: Resource path:
component: pingam
version: 8
page_id: pingam:entity-reference:sec-amster-entity-setsuccessdetails
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-setsuccessdetails.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
superseded_by: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-setsuccessdetails.html
section_ids:
  sec-amster-entity-setsuccessdetails-realm-ops: Realm Operations
  sec-amster-entity-setsuccessdetails-realm-ops-create: create
  sec-amster-entity-setsuccessdetails-realm-ops-delete: delete
  sec-amster-entity-setsuccessdetails-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-setsuccessdetails-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-setsuccessdetails-realm-ops-listoutcomes: listOutcomes
  sec-amster-entity-setsuccessdetails-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-setsuccessdetails-realm-ops-query: query
  sec-amster-entity-setsuccessdetails-realm-ops-read: read
  sec-amster-entity-setsuccessdetails-realm-ops-update: update
---

# SetSuccessDetails

## Realm Operations

Resource path:

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

Resource version: `2.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:

  ```json
  {
    "type" : "object",
    "properties" : {
      "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" : ""
      },
      "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" : ""
      }
    },
    "required" : [ "successDetails", "sessionProperties" ]
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action SetSuccessDetails --realm Realm --actionName getCreatableTypes
```

### 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:

  ```json
  {
    "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 SetSuccessDetails --realm Realm --actionName nextdescendents
```

### 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:

  ```json
  {
    "type" : "object",
    "properties" : {
      "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" : ""
      },
      "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" : ""
      }
    },
    "required" : [ "successDetails", "sessionProperties" ]
  }
  ```