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

# AnonymousModule

## Realm Operations

Resource path:

```
/realm-config/authentication/modules/anonymous
```

Resource version: `0.0`

### create

**Usage**

```
am> create AnonymousModule --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" : 400,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "defaultAnonymousUsername" : {
        "title" : "Default Anonymous User Name",
        "description" : "The default username to use if no username is supplied during authentication.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "validAnonymousUsers" : {
        "title" : "Valid Anonymous Users",
        "description" : "List of accounts that are allowed to login without providing credentials.<br><br>Any username on this list will be allows anonymous access to OpenAM. Usernames listed here must have matching profiles in the data store or the user profile requirement must be disabled. The username can be specified during anonymous authentication as follows:<br/><br/><code>/openam/UI/Login?module=anonymous&IDToken1=<i>username</i></code>",
        "propertyOrder" : 100,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "caseSensitiveUsernameMatchingEnabled" : {
        "title" : "Case Sensitive User IDs",
        "description" : "If enabled, username matching will be case sensitive.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### query

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

**Usage**

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

**Parameters**

* *\--filter*

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

### read

**Usage**

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

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update AnonymousModule --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" : 400,
        "required" : true,
        "type" : "integer",
        "exampleValue" : ""
      },
      "defaultAnonymousUsername" : {
        "title" : "Default Anonymous User Name",
        "description" : "The default username to use if no username is supplied during authentication.",
        "propertyOrder" : 200,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      },
      "validAnonymousUsers" : {
        "title" : "Valid Anonymous Users",
        "description" : "List of accounts that are allowed to login without providing credentials.<br><br>Any username on this list will be allows anonymous access to OpenAM. Usernames listed here must have matching profiles in the data store or the user profile requirement must be disabled. The username can be specified during anonymous authentication as follows:<br/><br/><code>/openam/UI/Login?module=anonymous&IDToken1=<i>username</i></code>",
        "propertyOrder" : 100,
        "required" : true,
        "items" : {
          "type" : "string"
        },
        "type" : "array",
        "exampleValue" : ""
      },
      "caseSensitiveUsernameMatchingEnabled" : {
        "title" : "Case Sensitive User IDs",
        "description" : "If enabled, username matching will be case sensitive.",
        "propertyOrder" : 300,
        "required" : true,
        "type" : "boolean",
        "exampleValue" : ""
      }
    }
  }
  ```

## Global Operations

Resource path:

```
/global-config/authentication/modules/anonymous
```

Resource version: `1.0`

### getAllTypes

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

**Usage**

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

### getCreatableTypes

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

**Usage**

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

### nextdescendents

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

**Usage**

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

### read

**Usage**

```
am> read AnonymousModule --global
```

### update

**Usage**

```
am> update AnonymousModule --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" : 400,
            "required" : true,
            "type" : "integer",
            "exampleValue" : ""
          },
          "defaultAnonymousUsername" : {
            "title" : "Default Anonymous User Name",
            "description" : "The default username to use if no username is supplied during authentication.",
            "propertyOrder" : 200,
            "required" : true,
            "type" : "string",
            "exampleValue" : ""
          },
          "caseSensitiveUsernameMatchingEnabled" : {
            "title" : "Case Sensitive User IDs",
            "description" : "If enabled, username matching will be case sensitive.",
            "propertyOrder" : 300,
            "required" : true,
            "type" : "boolean",
            "exampleValue" : ""
          },
          "validAnonymousUsers" : {
            "title" : "Valid Anonymous Users",
            "description" : "List of accounts that are allowed to login without providing credentials.<br><br>Any username on this list will be allows anonymous access to OpenAM. Usernames listed here must have matching profiles in the data store or the user profile requirement must be disabled. The username can be specified during anonymous authentication as follows:<br/><br/><code>/openam/UI/Login?module=anonymous&IDToken1=<i>username</i></code>",
            "propertyOrder" : 100,
            "required" : true,
            "items" : {
              "type" : "string"
            },
            "type" : "array",
            "exampleValue" : ""
          }
        },
        "type" : "object",
        "title" : "Realm Defaults"
      }
    }
  }
  ```