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

# MsisdnModule

## Realm Operations

Resource path:

```
/realm-config/authentication/modules/msisdn
```

Resource version: `0.0`

### create

**Usage**

```
am> create MsisdnModule --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" : {
      "ldapProviderUrl" : {
        "title" : "LDAP Server and Port ",
        "description" : "Use this list to set the LDAP server used to search for the MSISDN number. <br><br>The MSISDN authentication module will use this list as the server that is searched for a matching MSISDN number. A single entry must be in the format:<br/><br/><code>ldap_server:port</code><br/><br/>Multiple entries allow associations between OpenAM servers and a LDAP server. The format is:<br/><br/><code>local server name | server:port</code><br/><br/>The local server name is the full name of the server from the list of servers and sites.",
        "propertyOrder" : 300,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "ldapSslEnabled" : {
        "title" : "SSL/TLS for LDAP Access",
        "description" : "",
        "propertyOrder" : 800,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "baseSearchDN" : {
        "title" : "LDAP Start Search DN",
        "description" : "The start point in the LDAP server for the MSISDN search<br><br>When entering multiple entries, each entry must be prefixed with a local server name. Multiple entries allow different search Base DNs depending on the OpenAM server in use. The format is:<br/><br/><code>local server name | base dn</code><br/><br/>The local server name is the full name of the server from the list of servers and sites.",
        "propertyOrder" : 400,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "ldapUserBindDN" : {
        "title" : "LDAP Server Authentication User ",
        "description" : "DN of the user used by the module to authenticate to the LDAP server<br><br>The MSISDN module authenticates to the LDAP server in order to search for a matching number. The DN entered here represents the account used for said authentication and must have read/search access to the LDAP server.",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "ldapUserBindPassword" : {
        "title" : "LDAP Server Authentication Password",
        "description" : "The password for the authentication user",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "trustedGatewayIPAddresses" : {
        "title" : "Trusted Gateway IP Address",
        "description" : "The list of IP address that are trusted to send MSISDN authentication requests.<br><br>The client IP address of the authentication request is checked against this list, if the client IP is not listed then the authentication module will fail.<br/><br/><i>NB </i>If the list is empty then all hosts will be trusted.",
        "propertyOrder" : 100,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "returnUserDN" : {
        "title" : "Return User DN to DataStore",
        "description" : "Controls whether the DN or the username is returned as the authentication principal.",
        "propertyOrder" : 1100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "msisdnRequestSearchLocations" : {
        "title" : "MSISDN Header Search Attribute",
        "description" : "Controls the elements that are searched by the authentication module ",
        "propertyOrder" : 900,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "msisdnParameterNames" : {
        "title" : "MSISDN Number Search Parameter Name",
        "description" : "Name of the HTTP cookie, header or query parameter containing the MSISDN number<br><br>The MSISDN authentication module will check the incoming HTTP cookie, header or query parameter of the request for the MSISDN number. The order of checking is as follows:<br/><br/><ol><li>Cookie</li><li>Header</li><li>Query</li></ol><br/><br/><i>NB </i>The <i>MSISDN Header Search Attribute</i> controls what elements of the request is searched",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "userProfileMsisdnAttribute" : {
        "title" : "Attribute To Use To Search LDAP",
        "description" : "The name of the attribute searched in the user profiles for the MSISDN number",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "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" : 1200,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "msisdnUserNamingAttribute" : {
        "title" : "LDAP Attribute Used to Retrieve User Profile",
        "description" : "The name of the attribute returned from the user profile matched against the supplied MSISDN number",
        "propertyOrder" : 1000,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

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

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update MsisdnModule --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" : {
      "ldapProviderUrl" : {
        "title" : "LDAP Server and Port ",
        "description" : "Use this list to set the LDAP server used to search for the MSISDN number. <br><br>The MSISDN authentication module will use this list as the server that is searched for a matching MSISDN number. A single entry must be in the format:<br/><br/><code>ldap_server:port</code><br/><br/>Multiple entries allow associations between OpenAM servers and a LDAP server. The format is:<br/><br/><code>local server name | server:port</code><br/><br/>The local server name is the full name of the server from the list of servers and sites.",
        "propertyOrder" : 300,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "ldapSslEnabled" : {
        "title" : "SSL/TLS for LDAP Access",
        "description" : "",
        "propertyOrder" : 800,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "baseSearchDN" : {
        "title" : "LDAP Start Search DN",
        "description" : "The start point in the LDAP server for the MSISDN search<br><br>When entering multiple entries, each entry must be prefixed with a local server name. Multiple entries allow different search Base DNs depending on the OpenAM server in use. The format is:<br/><br/><code>local server name | base dn</code><br/><br/>The local server name is the full name of the server from the list of servers and sites.",
        "propertyOrder" : 400,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "ldapUserBindDN" : {
        "title" : "LDAP Server Authentication User ",
        "description" : "DN of the user used by the module to authenticate to the LDAP server<br><br>The MSISDN module authenticates to the LDAP server in order to search for a matching number. The DN entered here represents the account used for said authentication and must have read/search access to the LDAP server.",
        "propertyOrder" : 600,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "ldapUserBindPassword" : {
        "title" : "LDAP Server Authentication Password",
        "description" : "The password for the authentication user",
        "propertyOrder" : 700,
        "required" : true,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "trustedGatewayIPAddresses" : {
        "title" : "Trusted Gateway IP Address",
        "description" : "The list of IP address that are trusted to send MSISDN authentication requests.<br><br>The client IP address of the authentication request is checked against this list, if the client IP is not listed then the authentication module will fail.<br/><br/><i>NB </i>If the list is empty then all hosts will be trusted.",
        "propertyOrder" : 100,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "returnUserDN" : {
        "title" : "Return User DN to DataStore",
        "description" : "Controls whether the DN or the username is returned as the authentication principal.",
        "propertyOrder" : 1100,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "msisdnRequestSearchLocations" : {
        "title" : "MSISDN Header Search Attribute",
        "description" : "Controls the elements that are searched by the authentication module ",
        "propertyOrder" : 900,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "msisdnParameterNames" : {
        "title" : "MSISDN Number Search Parameter Name",
        "description" : "Name of the HTTP cookie, header or query parameter containing the MSISDN number<br><br>The MSISDN authentication module will check the incoming HTTP cookie, header or query parameter of the request for the MSISDN number. The order of checking is as follows:<br/><br/><ol><li>Cookie</li><li>Header</li><li>Query</li></ol><br/><br/><i>NB </i>The <i>MSISDN Header Search Attribute</i> controls what elements of the request is searched",
        "propertyOrder" : 200,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "userProfileMsisdnAttribute" : {
        "title" : "Attribute To Use To Search LDAP",
        "description" : "The name of the attribute searched in the user profiles for the MSISDN number",
        "propertyOrder" : 500,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "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" : 1200,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "msisdnUserNamingAttribute" : {
        "title" : "LDAP Attribute Used to Retrieve User Profile",
        "description" : "The name of the attribute returned from the user profile matched against the supplied MSISDN number",
        "propertyOrder" : 1000,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/authentication/modules/msisdn
```

Resource version: `1.0`

### getAllTypes

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

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### read

**Usage**

```
am> read MsisdnModule --global
```

### update

**Usage**

```
am> update MsisdnModule --global --body body
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "properties" : {
      "defaults" : {
        "properties" : {
          "ldapUserBindDN" : {
            "title" : "LDAP Server Authentication User ",
            "description" : "DN of the user used by the module to authenticate to the LDAP server<br><br>The MSISDN module authenticates to the LDAP server in order to search for a matching number. The DN entered here represents the account used for said authentication and must have read/search access to the LDAP server.",
            "propertyOrder" : 600,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "ldapProviderUrl" : {
            "title" : "LDAP Server and Port ",
            "description" : "Use this list to set the LDAP server used to search for the MSISDN number. <br><br>The MSISDN authentication module will use this list as the server that is searched for a matching MSISDN number. A single entry must be in the format:<br/><br/><code>ldap_server:port</code><br/><br/>Multiple entries allow associations between OpenAM servers and a LDAP server. The format is:<br/><br/><code>local server name | server:port</code><br/><br/>The local server name is the full name of the server from the list of servers and sites.",
            "propertyOrder" : 300,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          },
          "msisdnRequestSearchLocations" : {
            "title" : "MSISDN Header Search Attribute",
            "description" : "Controls the elements that are searched by the authentication module ",
            "propertyOrder" : 900,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          },
          "userProfileMsisdnAttribute" : {
            "title" : "Attribute To Use To Search LDAP",
            "description" : "The name of the attribute searched in the user profiles for the MSISDN number",
            "propertyOrder" : 500,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "trustedGatewayIPAddresses" : {
            "title" : "Trusted Gateway IP Address",
            "description" : "The list of IP address that are trusted to send MSISDN authentication requests.<br><br>The client IP address of the authentication request is checked against this list, if the client IP is not listed then the authentication module will fail.<br/><br/><i>NB </i>If the list is empty then all hosts will be trusted.",
            "propertyOrder" : 100,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          },
          "msisdnUserNamingAttribute" : {
            "title" : "LDAP Attribute Used to Retrieve User Profile",
            "description" : "The name of the attribute returned from the user profile matched against the supplied MSISDN number",
            "propertyOrder" : 1000,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "msisdnParameterNames" : {
            "title" : "MSISDN Number Search Parameter Name",
            "description" : "Name of the HTTP cookie, header or query parameter containing the MSISDN number<br><br>The MSISDN authentication module will check the incoming HTTP cookie, header or query parameter of the request for the MSISDN number. The order of checking is as follows:<br/><br/><ol><li>Cookie</li><li>Header</li><li>Query</li></ol><br/><br/><i>NB </i>The <i>MSISDN Header Search Attribute</i> controls what elements of the request is searched",
            "propertyOrder" : 200,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          },
          "returnUserDN" : {
            "title" : "Return User DN to DataStore",
            "description" : "Controls whether the DN or the username is returned as the authentication principal.",
            "propertyOrder" : 1100,
            "required" : true,
            "type" : "boolean",
            "exampleValue" : ""
          },
          "baseSearchDN" : {
            "title" : "LDAP Start Search DN",
            "description" : "The start point in the LDAP server for the MSISDN search<br><br>When entering multiple entries, each entry must be prefixed with a local server name. Multiple entries allow different search Base DNs depending on the OpenAM server in use. The format is:<br/><br/><code>local server name | base dn</code><br/><br/>The local server name is the full name of the server from the list of servers and sites.",
            "propertyOrder" : 400,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          },
          "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" : 1200,
            "required" : true,
            "type" : "integer",
            "exampleValue" : ""
          },
          "ldapUserBindPassword" : {
            "title" : "LDAP Server Authentication Password",
            "description" : "The password for the authentication user",
            "propertyOrder" : 700,
            "required" : true,
            "type" : "string",
            "format" : "password",
            "exampleValue" : ""
          },
          "ldapSslEnabled" : {
            "title" : "SSL/TLS for LDAP Access",
            "description" : "",
            "propertyOrder" : 800,
            "required" : true,
            "type" : "boolean",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```