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

# DataStoreModule

## Realm Operations

Resource path:

```
/realm-config/authentication/modules/datastore
```

Resource version: `0.0`

### create

**Usage**

```
am> create DataStoreModule --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" : {
      "authenticationLevel" : {
        "title" : "Authentication Level",
        "description" : "The authentication level associated with this module.<br><br>Each authentication module has an authentication level that can be used to indicate the level of security associated with the module; 0 is the lowest (and the default).",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query DataStoreModule --realm Realm --filter filter
```

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update DataStoreModule --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" : {
      "authenticationLevel" : {
        "title" : "Authentication Level",
        "description" : "The authentication level associated with this module.<br><br>Each authentication module has an authentication level that can be used to indicate the level of security associated with the module; 0 is the lowest (and the default).",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/authentication/modules/datastore
```

Resource version: `1.0`

### getAllTypes

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

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### read

**Usage**

```
am> read DataStoreModule --global
```

### update

**Usage**

```
am> update DataStoreModule --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "defaults" : {
        "properties" : {
          "authenticationLevel" : {
            "title" : "Authentication Level",
            "description" : "The authentication level associated with this module.<br><br>Each authentication module has an authentication level that can be used to indicate the level of security associated with the module; 0 is the lowest (and the default).",
            "propertyOrder" : 100,
            "required" : true,
            "type" : "integer",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```