---
title: SessionPropertyWhiteList
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-sessionpropertywhitelist
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-sessionpropertywhitelist.html
section_ids:
  sec-amster-entity-sessionpropertywhitelist-realm-ops: Realm Operations
  sec-amster-entity-sessionpropertywhitelist-realm-ops-create: create
  sec-amster-entity-sessionpropertywhitelist-realm-ops-delete: delete
  sec-amster-entity-sessionpropertywhitelist-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-sessionpropertywhitelist-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-sessionpropertywhitelist-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-sessionpropertywhitelist-realm-ops-read: read
  sec-amster-entity-sessionpropertywhitelist-realm-ops-update: update
  sec-amster-entity-sessionpropertywhitelist-global-ops: Global Operations
  sec-amster-entity-sessionpropertywhitelist-global-ops-getalltypes: getAllTypes
  sec-amster-entity-sessionpropertywhitelist-global-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-sessionpropertywhitelist-global-ops-nextdescendents: nextdescendents
  sec-amster-entity-sessionpropertywhitelist-global-ops-read: read
  sec-amster-entity-sessionpropertywhitelist-global-ops-update: update
---

# SessionPropertyWhiteList

## Realm Operations

Resource path:

```
/realm-config/services/amSessionPropertyWhitelist
```

Resource version: `0.0`

### create

**Usage**

```
am> create SessionPropertyWhiteList --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "whitelistedQueryProperties" : {
        "title" : "Session Properties to return for session queries",
        "description" : "A list of session properties that can be returned to admins in a REST session query response.<p><p>This setting may impact REST query performance - when session properties are added, the CTS token must be retrieved, and will be the subject of decryption and decompression, if configured.<p><p> Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this list.",
        "propertyOrder" : 110,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "sessionPropertyWhitelist" : {
        "title" : "Allowlisted Session Property Names",
        "description" : "A list of properties that users may read, edit the value of, or delete from their session.<p><p> Adding properties to sessions can impact OpenAM's performance. Because there is no size constraint limiting the set of properties that you can add to sessions, and no limit on the number of session properties you can add, keep in mind that adding session properties can increase the load on an OpenAM deployment in the following areas: <ul><li>OpenAM server memory</li><li>OpenDJ storage</li><li>OpenDJ replication</li></ul><p>Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this allowlist.",
        "propertyOrder" : 100,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete SessionPropertyWhiteList --realm Realm
```

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action SessionPropertyWhiteList --realm Realm --actionName getAllTypes
```

### getCreatableTypes

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

**Usage**

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

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action SessionPropertyWhiteList --realm Realm --actionName nextdescendents
```

### read

**Usage**

```
am> read SessionPropertyWhiteList --realm Realm
```

### update

**Usage**

```
am> update SessionPropertyWhiteList --realm Realm --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "whitelistedQueryProperties" : {
        "title" : "Session Properties to return for session queries",
        "description" : "A list of session properties that can be returned to admins in a REST session query response.<p><p>This setting may impact REST query performance - when session properties are added, the CTS token must be retrieved, and will be the subject of decryption and decompression, if configured.<p><p> Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this list.",
        "propertyOrder" : 110,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "sessionPropertyWhitelist" : {
        "title" : "Allowlisted Session Property Names",
        "description" : "A list of properties that users may read, edit the value of, or delete from their session.<p><p> Adding properties to sessions can impact OpenAM's performance. Because there is no size constraint limiting the set of properties that you can add to sessions, and no limit on the number of session properties you can add, keep in mind that adding session properties can increase the load on an OpenAM deployment in the following areas: <ul><li>OpenAM server memory</li><li>OpenDJ storage</li><li>OpenDJ replication</li></ul><p>Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this allowlist.",
        "propertyOrder" : 100,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/services/amSessionPropertyWhitelist
```

Resource version: `1.0`

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action SessionPropertyWhiteList --global --actionName getAllTypes
```

### getCreatableTypes

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

**Usage**

```
am> action SessionPropertyWhiteList --global --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action SessionPropertyWhiteList --global --actionName nextdescendents
```

### read

**Usage**

```
am> read SessionPropertyWhiteList --global
```

### update

**Usage**

```
am> update SessionPropertyWhiteList --global --body body
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "defaults" : {
        "properties" : {
          "sessionPropertyWhitelist" : {
            "title" : "Allowlisted Session Property Names",
            "description" : "A list of properties that users may read, edit the value of, or delete from their session.<p><p> Adding properties to sessions can impact OpenAM's performance. Because there is no size constraint limiting the set of properties that you can add to sessions, and no limit on the number of session properties you can add, keep in mind that adding session properties can increase the load on an OpenAM deployment in the following areas: <ul><li>OpenAM server memory</li><li>OpenDJ storage</li><li>OpenDJ replication</li></ul><p>Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this allowlist.",
            "propertyOrder" : 100,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          },
          "whitelistedQueryProperties" : {
            "title" : "Session Properties to return for session queries",
            "description" : "A list of session properties that can be returned to admins in a REST session query response.<p><p>This setting may impact REST query performance - when session properties are added, the CTS token must be retrieved, and will be the subject of decryption and decompression, if configured.<p><p> Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this list.",
            "propertyOrder" : 110,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```
