> For the complete documentation index, see [llms.txt](https://docs.lithnet.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.lithnet.io/password-protection/v1.0/advanced-help/powershell-reference/test-isbannedword.md).

# Test-IsBannedWord

The `Test-IsBannedWord` cmdlet checks to see if a specified string matches a value in the banned word store. The [normalization rules](/password-protection/v1.0/help-and-support/normalization-rules.md) are applied to the string and the resulting value is checked against the store.

## Syntax

```
Test-IsBannedWord -Value <string>

Test-IsBannedWord -Hash <byte[]>

Test-IsBannedWord -SecureString <SecureString>
```

### Parameters

**`Value`**

Required. The string to test. [Normalization rules](/password-protection/v1.0/help-and-support/normalization-rules.md) are applied to this string before it is checked against the store

**`Hash`**

Required. A binary hash to test. A hash cannot be normalized, so it is tested as-is.

**`SecureString`**

Required. The string to test as a SecureString. [Normalization rules](/password-protection/v1.0/help-and-support/normalization-rules.md) are applied to this string before it is checked against the store

### Return value

The cmdlet returns a boolean value indicating whether the input string or hash matches a value in the banned word store.

### Examples

```powershell
# Add a word to the store
PS> Add-BannedWord -Value password

# Test the exact word and ensure it is found
PS> Test-IsBannedWord -Value password
True

# Test a modification of the banned word, and ensure it is found
PS> Test-IsBannedWord -Value P@ssw0rd!
True

# Prompt for a banned word to test
PS> Test-IsBannedWord -SecureString (Read-Host -Prompt "Enter the banned word to test" -AsSecureString)
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.lithnet.io/password-protection/v1.0/advanced-help/powershell-reference/test-isbannedword.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.