---
title: RemoveSessionProperties
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-removesessionproperties
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-removesessionproperties.html
section_ids:
  sec-amster-entity-removesessionproperties-realm-ops: Realm Operations
  sec-amster-entity-removesessionproperties-realm-ops-create: create
  sec-amster-entity-removesessionproperties-realm-ops-delete: delete
  sec-amster-entity-removesessionproperties-realm-ops-gettype: getType
  sec-amster-entity-removesessionproperties-realm-ops-getupgradedconfig: getUpgradedConfig
  sec-amster-entity-removesessionproperties-realm-ops-query: query
  sec-amster-entity-removesessionproperties-realm-ops-read: read
  sec-amster-entity-removesessionproperties-realm-ops-update: update
  sec-amster-entity-removesessionproperties-realm-ops-versioninfo: versionInfo
---

# RemoveSessionProperties

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/RemoveSessionPropertiesNode/1.0
```

Resource version: `3.0`

### create

**Usage**

```
am> create RemoveSessionProperties --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" : {
      "propertyNames" : {
        "title" : "Property Names",
        "description" : "The names of session properties to remove that may have been contributed by nodes that executedearlier in the tree. If the properties do not exist, no error will be thrown. Names are case sensitive.",
        "propertyOrder" : 100,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      }
    },
    "required" : [ "propertyNames" ]
  }
  ```

### delete

**Usage**

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

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

```
am> read RemoveSessionProperties --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update RemoveSessionProperties --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" : {
      "propertyNames" : {
        "title" : "Property Names",
        "description" : "The names of session properties to remove that may have been contributed by nodes that executedearlier in the tree. If the properties do not exist, no error will be thrown. Names are case sensitive.",
        "propertyOrder" : 100,
        "items" : {
          "type" : "string"
        },
        "minItems" : 1,
        "type" : "array",
        "exampleValue" : ""
      }
    },
    "required" : [ "propertyNames" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

```
am> action RemoveSessionProperties --realm Realm --actionName versionInfo
```