---
title: DefaultUmaDataStoreProperties
description: An object of property key-value pairs
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-defaultumadatastoreproperties
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-defaultumadatastoreproperties.html
section_ids:
  sec-amster-entity-defaultumadatastoreproperties-global-ops: Global Operations
  sec-amster-entity-defaultumadatastoreproperties-global-ops-read: read
  sec-amster-entity-defaultumadatastoreproperties-global-ops-update: update
---

# DefaultUmaDataStoreProperties

## Global Operations

An object of property key-value pairs

Resource path:

```
/global-config/servers/server-default/properties/uma
```

Resource version: `1.0`

### read

**Usage**

```
am> read DefaultUmaDataStoreProperties --global
```

### update

**Usage**

```
am> update DefaultUmaDataStoreProperties --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "amconfig.org.forgerock.services.resourcesets.store.common.section" : {
        "title" : "UMA Resource Store",
        "type" : "object",
        "propertyOrder" : 0,
        "properties" : {
          "org.forgerock.services.resourcesets.store.location" : {
            "enum" : [ "default", "external" ],
            "options" : {
              "enum_titles" : [ "Default Token Store", "External Token Store" ]
            },
            "type" : "string",
            "title" : "Store Mode",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.resourcesets.store.root.suffix" : {
            "type" : "string",
            "title" : "Root Suffix",
            "propertyOrder" : 1,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.resourcesets.store.max.connections" : {
            "type" : "string",
            "title" : "Max Connections",
            "propertyOrder" : 2,
            "required" : true,
            "description" : ""
          }
        }
      },
      "amconfig.org.forgerock.services.resourcesets.store.external.section" : {
        "title" : "External UMA Resource Store Configuration",
        "type" : "object",
        "propertyOrder" : 1,
        "properties" : {
          "org.forgerock.services.resourcesets.store.ssl.enabled" : {
            "type" : "boolean",
            "title" : "SSL/TLS Enabled",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.resourcesets.store.mtls.enabled" : {
            "type" : "boolean",
            "title" : "mTLS Enabled",
            "propertyOrder" : 1,
            "required" : true,
            "description" : "Enables mTLS (mutual TLS) between AM and this store. When mTLS is enabled:<ul><li>Set <code>SSL/TLS Enabled</code>. <li>Set a secure port in <code>Connection String(s)</code>.</li> <li>The values for <code>Login Id</code> and <code>Password</code> are ignored.</li></ul>Instructions for setting up certificates and keystore mappings are in the product documentation."
          },
          "org.forgerock.services.resourcesets.store.starttls.enabled" : {
            "type" : "boolean",
            "title" : "Start TLS",
            "propertyOrder" : 2,
            "required" : true,
            "description" : "Specifies whether to use StartTLS for the connection."
          },
          "org.forgerock.services.resourcesets.store.directory.name" : {
            "type" : "string",
            "title" : "Connection String(s)",
            "propertyOrder" : 3,
            "required" : true,
            "description" : "An ordered list of connection strings for LDAP directories. Each connection string is composed as follows: <code>HOST:PORT[|SERVERID[|SITEID]]</code>, where server and site IDs are optional parameters that will prioritize that connection to use from the specified nodes. Multiple connection strings should be comma-separated, e.g. <code>host1:389,host2:50389|server1|site1,host3:50389</code>."
          },
          "org.forgerock.services.resourcesets.store.loginid" : {
            "type" : "string",
            "title" : "Login Id",
            "propertyOrder" : 4,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set."
          },
          "org.forgerock.services.resourcesets.store.password" : {
            "type" : "string",
            "title" : "Password",
            "propertyOrder" : 5,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
            "format" : "password"
          },
          "org.forgerock.services.resourcesets.store.heartbeat" : {
            "type" : "integer",
            "title" : "Heartbeat",
            "propertyOrder" : 6,
            "required" : true,
            "description" : ""
          }
        }
      },
      "amconfig.org.forgerock.services.umaaudit.store.common.section" : {
        "title" : "UMA Audit Store",
        "type" : "object",
        "propertyOrder" : 2,
        "properties" : {
          "org.forgerock.services.umaaudit.store.location" : {
            "enum" : [ "default", "external" ],
            "options" : {
              "enum_titles" : [ "Default Token Store", "External Token Store" ]
            },
            "type" : "string",
            "title" : "Store Mode",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.umaaudit.store.root.suffix" : {
            "type" : "string",
            "title" : "Root Suffix",
            "propertyOrder" : 1,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.umaaudit.store.max.connections" : {
            "type" : "string",
            "title" : "Max Connections",
            "propertyOrder" : 2,
            "required" : true,
            "description" : ""
          }
        }
      },
      "amconfig.org.forgerock.services.umaaudit.store.external.section" : {
        "title" : "External UMA Audit Store Configuration",
        "type" : "object",
        "propertyOrder" : 3,
        "properties" : {
          "org.forgerock.services.umaaudit.store.ssl.enabled" : {
            "type" : "boolean",
            "title" : "SSL/TLS Enabled",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.umaaudit.store.mtls.enabled" : {
            "type" : "boolean",
            "title" : "mTLS Enabled",
            "propertyOrder" : 1,
            "required" : true,
            "description" : "Enables mTLS (mutual TLS) between AM and this store. When mTLS is enabled:<ul><li>Set <code>SSL/TLS Enabled</code>. <li>Set a secure port in <code>Connection String(s)</code>.</li> <li>The values for <code>Login Id</code> and <code>Password</code> are ignored.</li></ul>Instructions for setting up certificates and keystore mappings are in the product documentation."
          },
          "org.forgerock.services.umaaudit.store.starttls.enabled" : {
            "type" : "boolean",
            "title" : "Start TLS",
            "propertyOrder" : 2,
            "required" : true,
            "description" : "Specifies whether to use StartTLS for the connection."
          },
          "org.forgerock.services.umaaudit.store.directory.name" : {
            "type" : "string",
            "title" : "Connection String(s)",
            "propertyOrder" : 3,
            "required" : true,
            "description" : "An ordered list of connection strings for LDAP directories. Each connection string is composed as follows: <code>HOST:PORT[|SERVERID[|SITEID]]</code>, where server and site IDs are optional parameters that will prioritize that connection to use from the specified nodes. Multiple connection strings should be comma-separated, e.g. <code>host1:389,host2:50389|server1|site1,host3:50389</code>."
          },
          "org.forgerock.services.umaaudit.store.loginid" : {
            "type" : "string",
            "title" : "Login Id",
            "propertyOrder" : 4,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set."
          },
          "org.forgerock.services.umaaudit.store.password" : {
            "type" : "string",
            "title" : "Password",
            "propertyOrder" : 5,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
            "format" : "password"
          },
          "org.forgerock.services.umaaudit.store.heartbeat" : {
            "type" : "integer",
            "title" : "Heartbeat",
            "propertyOrder" : 6,
            "required" : true,
            "description" : ""
          }
        }
      },
      "amconfig.org.forgerock.services.uma.pendingrequests.store.common.section" : {
        "title" : "Pending Requests Store",
        "type" : "object",
        "propertyOrder" : 4,
        "properties" : {
          "org.forgerock.services.uma.pendingrequests.store.location" : {
            "enum" : [ "default", "external" ],
            "options" : {
              "enum_titles" : [ "Default Token Store", "External Token Store" ]
            },
            "type" : "string",
            "title" : "Store Mode",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.uma.pendingrequests.store.root.suffix" : {
            "type" : "string",
            "title" : "Root Suffix",
            "propertyOrder" : 1,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.uma.pendingrequests.store.max.connections" : {
            "type" : "string",
            "title" : "Max Connections",
            "propertyOrder" : 2,
            "required" : true,
            "description" : ""
          }
        }
      },
      "amconfig.org.forgerock.services.uma.pendingrequests.store.external.section" : {
        "title" : "External Pending Requests Store Configuration",
        "type" : "object",
        "propertyOrder" : 5,
        "properties" : {
          "org.forgerock.services.uma.pendingrequests.store.ssl.enabled" : {
            "type" : "boolean",
            "title" : "SSL/TLS Enabled",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.uma.pendingrequests.store.mtls.enabled" : {
            "type" : "boolean",
            "title" : "mTLS Enabled",
            "propertyOrder" : 1,
            "required" : true,
            "description" : "Enables mTLS (mutual TLS) between AM and this store. When mTLS is enabled:<ul><li>Set <code>SSL/TLS Enabled</code>. <li>Set a secure port in <code>Connection String(s)</code>.</li> <li>The values for <code>Login Id</code> and <code>Password</code> are ignored.</li></ul>Instructions for setting up certificates and keystore mappings are in the product documentation."
          },
          "org.forgerock.services.uma.pendingrequests.store.starttls.enabled" : {
            "type" : "boolean",
            "title" : "Start TLS",
            "propertyOrder" : 2,
            "required" : true,
            "description" : "Specifies whether to use StartTLS for the connection."
          },
          "org.forgerock.services.uma.pendingrequests.store.directory.name" : {
            "type" : "string",
            "title" : "Connection String(s)",
            "propertyOrder" : 3,
            "required" : true,
            "description" : "An ordered list of connection strings for LDAP directories. Each connection string is composed as follows: <code>HOST:PORT[|SERVERID[|SITEID]]</code>, where server and site IDs are optional parameters that will prioritize that connection to use from the specified nodes. Multiple connection strings should be comma-separated, e.g. <code>host1:389,host2:50389|server1|site1,host3:50389</code>."
          },
          "org.forgerock.services.uma.pendingrequests.store.loginid" : {
            "type" : "string",
            "title" : "Login Id",
            "propertyOrder" : 4,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set."
          },
          "org.forgerock.services.uma.pendingrequests.store.password" : {
            "type" : "string",
            "title" : "Password",
            "propertyOrder" : 5,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
            "format" : "password"
          },
          "org.forgerock.services.uma.pendingrequests.store.heartbeat" : {
            "type" : "integer",
            "title" : "Heartbeat",
            "propertyOrder" : 6,
            "required" : true,
            "description" : ""
          }
        }
      },
      "amconfig.org.forgerock.services.uma.labels.store.common.section" : {
        "title" : "UMA Resource Labels Store",
        "type" : "object",
        "propertyOrder" : 6,
        "properties" : {
          "org.forgerock.services.uma.labels.store.location" : {
            "enum" : [ "default", "external" ],
            "options" : {
              "enum_titles" : [ "Default Token Store", "External Token Store" ]
            },
            "type" : "string",
            "title" : "Store Mode",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.uma.labels.store.root.suffix" : {
            "type" : "string",
            "title" : "Root Suffix",
            "propertyOrder" : 1,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.uma.labels.store.max.connections" : {
            "type" : "string",
            "title" : "Max Connections",
            "propertyOrder" : 2,
            "required" : true,
            "description" : ""
          }
        }
      },
      "amconfig.org.forgerock.services.uma.labels.store.external.section" : {
        "title" : "External UMA Resource Labels Store Configuration",
        "type" : "object",
        "propertyOrder" : 7,
        "properties" : {
          "org.forgerock.services.uma.labels.store.ssl.enabled" : {
            "type" : "boolean",
            "title" : "SSL/TLS Enabled",
            "propertyOrder" : 0,
            "required" : true,
            "description" : ""
          },
          "org.forgerock.services.uma.labels.store.mtls.enabled" : {
            "type" : "boolean",
            "title" : "mTLS Enabled",
            "propertyOrder" : 1,
            "required" : true,
            "description" : "Enables mTLS (mutual TLS) between AM and this store. When mTLS is enabled:<ul><li>Set <code>SSL/TLS Enabled</code>. <li>Set a secure port in <code>Connection String(s)</code>.</li> <li>The values for <code>Login Id</code> and <code>Password</code> are ignored.</li></ul>Instructions for setting up certificates and keystore mappings are in the product documentation."
          },
          "org.forgerock.services.uma.labels.store.starttls.enabled" : {
            "type" : "boolean",
            "title" : "Start TLS",
            "propertyOrder" : 2,
            "required" : true,
            "description" : "Specifies whether to use StartTLS for the connection."
          },
          "org.forgerock.services.uma.labels.store.directory.name" : {
            "type" : "string",
            "title" : "Connection String(s)",
            "propertyOrder" : 3,
            "required" : true,
            "description" : "An ordered list of connection strings for LDAP directories. Each connection string is composed as follows: <code>HOST:PORT[|SERVERID[|SITEID]]</code>, where server and site IDs are optional parameters that will prioritize that connection to use from the specified nodes. Multiple connection strings should be comma-separated, e.g. <code>host1:389,host2:50389|server1|site1,host3:50389</code>."
          },
          "org.forgerock.services.uma.labels.store.loginid" : {
            "type" : "string",
            "title" : "Login Id",
            "propertyOrder" : 4,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set."
          },
          "org.forgerock.services.uma.labels.store.password" : {
            "type" : "string",
            "title" : "Password",
            "propertyOrder" : 5,
            "required" : true,
            "description" : "This property is ignored if <code>mTLS Enabled</code> is set.",
            "format" : "password"
          },
          "org.forgerock.services.uma.labels.store.heartbeat" : {
            "type" : "integer",
            "title" : "Heartbeat",
            "propertyOrder" : 6,
            "required" : true,
            "description" : ""
          }
        }
      }
    }
  }
  ```