---
title: WindowsNtModule
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-windowsntmodule
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-windowsntmodule.html
section_ids:
sec-amster-entity-windowsntmodule-realm-ops: Realm Operations
sec-amster-entity-windowsntmodule-realm-ops-create: create
sec-amster-entity-windowsntmodule-realm-ops-delete: delete
sec-amster-entity-windowsntmodule-realm-ops-getalltypes: getAllTypes
sec-amster-entity-windowsntmodule-realm-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-windowsntmodule-realm-ops-nextdescendents: nextdescendents
sec-amster-entity-windowsntmodule-realm-ops-query: query
sec-amster-entity-windowsntmodule-realm-ops-read: read
sec-amster-entity-windowsntmodule-realm-ops-update: update
sec-amster-entity-windowsntmodule-global-ops: Global Operations
sec-amster-entity-windowsntmodule-global-ops-getalltypes: getAllTypes
sec-amster-entity-windowsntmodule-global-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-windowsntmodule-global-ops-nextdescendents: nextdescendents
sec-amster-entity-windowsntmodule-global-ops-read: read
sec-amster-entity-windowsntmodule-global-ops-update: update
---
# WindowsNtModule
## Realm Operations
Resource path:
```
/realm-config/authentication/modules/windowsnt
```
Resource version: `0.0`
### create
**Usage**
```
am> create WindowsNtModule --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" : {
"sambaConfigurationFileName" : {
"title" : "Samba Configuration File Name",
"description" : "The path to the Samba configuration file.
The Windows NT authentication module uses the smbclient command to validate the user credentials against the Windows domain controller.
For example: /opt/openam/smb.conf
NB The smbclient command must be available in the PATH environmental variable associated with OpenAM.",
"propertyOrder" : 300,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"authenticationDomain" : {
"title" : "Authentication Domain",
"description" : "The name of the Windows Domain used for authentication",
"propertyOrder" : 100,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"authenticationLevel" : {
"title" : "Authentication Level",
"description" : "The authentication level associated with this module.
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" : 400,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"authenticationHost" : {
"title" : "Authentication Host",
"description" : "The name of the Windows NT Domain Controller.",
"propertyOrder" : 200,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
```
### delete
**Usage**
```
am> delete WindowsNtModule --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 WindowsNtModule --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action WindowsNtModule --realm Realm --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action WindowsNtModule --realm Realm --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query WindowsNtModule --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read WindowsNtModule --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update WindowsNtModule --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" : {
"sambaConfigurationFileName" : {
"title" : "Samba Configuration File Name",
"description" : "The path to the Samba configuration file.
The Windows NT authentication module uses the smbclient command to validate the user credentials against the Windows domain controller.
For example: /opt/openam/smb.conf
NB The smbclient command must be available in the PATH environmental variable associated with OpenAM.",
"propertyOrder" : 300,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"authenticationDomain" : {
"title" : "Authentication Domain",
"description" : "The name of the Windows Domain used for authentication",
"propertyOrder" : 100,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"authenticationLevel" : {
"title" : "Authentication Level",
"description" : "The authentication level associated with this module.
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" : 400,
"required" : true,
"type" : "integer",
"exampleValue" : ""
},
"authenticationHost" : {
"title" : "Authentication Host",
"description" : "The name of the Windows NT Domain Controller.",
"propertyOrder" : 200,
"required" : true,
"type" : "string",
"exampleValue" : ""
}
}
}
```
## Global Operations
Resource path:
```
/global-config/authentication/modules/windowsnt
```
Resource version: `1.0`
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action WindowsNtModule --global --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action WindowsNtModule --global --actionName getCreatableTypes
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action WindowsNtModule --global --actionName nextdescendents
```
### read
**Usage**
```
am> read WindowsNtModule --global
```
### update
**Usage**
```
am> update WindowsNtModule --global --body body
```
**Parameters**
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"defaults" : {
"properties" : {
"authenticationHost" : {
"title" : "Authentication Host",
"description" : "The name of the Windows NT Domain Controller.",
"propertyOrder" : 200,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"authenticationDomain" : {
"title" : "Authentication Domain",
"description" : "The name of the Windows Domain used for authentication",
"propertyOrder" : 100,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"sambaConfigurationFileName" : {
"title" : "Samba Configuration File Name",
"description" : "The path to the Samba configuration file.
The Windows NT authentication module uses the smbclient command to validate the user credentials against the Windows domain controller.
For example: /opt/openam/smb.conf
NB The smbclient command must be available in the PATH environmental variable associated with OpenAM.",
"propertyOrder" : 300,
"required" : true,
"type" : "string",
"exampleValue" : ""
},
"authenticationLevel" : {
"title" : "Authentication Level",
"description" : "The authentication level associated with this module.
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" : 400,
"required" : true,
"type" : "integer",
"exampleValue" : ""
}
},
"type" : "object",
"title" : "Realm Defaults"
}
}
}
```