ip-whitelist

Files (9)

• SKILL.md
• add-ip.ts
• clients.csv
• environments.csv
• find-clients.ts
• ip-whitelist-design.md
• list-for-all-clients.ts
• remove-ip.ts
• show-for-client.ts

SKILL.md (first lines)

# IP Whitelist Skill

## What I Do

This skill manages the IP whitelist for Provider Nexus API clients using `curl`
calls.

### Configuration

**Environment**

All script files require the `--env=<environment>` parameter to specify the target
environment. The list of environments is found in
`skill/ip_whitelist/environments.csv`. If you are requested to use this skill and the
environment is not specified, read the file and provide the following response:

```
To use the IP Whitelist Skill, please specify the environment:
    1. Local       | `http://localhost:5001`             |
    2. Staging     | `https://staging.providernexus.com` |
    <remaining list>

Which environment would you like to use?
```

If the response is an name or number, map it to the corresponding
environment.

**Clients**

Some scripts require the `--client-id=<client_id>` parameter. Clients are listed in
`skill/ip_whitelist/clients.csv`. If a client is required for the action and is not
provided, ask the user to provide it. If the user provides a client name, map it to
the corresponding client ID or ask for clarification and provide options if there are
multiple matches.

> Note: Special Client IDs
> Client Strenuus (12) is used for administrative accounts in all environments.
> Client HealthStart (292) is used for developers in Staging and Sandbox.
> Always use Localhost for testing.

**IP Addresses**

Some scripts require the `--ip-address=<ip_or_cidr>` parameter.

### Available Actions

All scripts return the HTTP status code on the first line followed by the response
body. Example:

```
HTTP Status: 200
[
  {
    "clientId": "client123",
    "ips": [
      { "ip": "192.168.1.10", "userId": "userA", "netmask": "255.255.255.0" },
      { "ip": "10.0.0.5" }
    ]
  }
]
```

#### 1. List All Whitelisted Client IPs

Returns all whitelisted IPs for all clients.

```bash
skill/ip_whitelist/list-for-all-clients --env=<environment>
```

**Response Example:**

```
HTTP Status: 200
[
  {
    "clientId": "client123",
    "ips": [
      { "ip": "192.168.1.10", "userId": "userA", "netmask": "255.255.255.0" },
      { "ip": "10.0.0.5" }
    ]
  }
]
```

#### 2. Show Whitelisted IPs for a Specific Client

Returns all whitelisted IPs for the specified client.

```bash
skill/ip_whitelist/show-for-client.ts --env=<environment> --client-id=<client_id>
```

**Response Example:**

```
HTTP Status: 200
{
  "clientId": "client123",
  "ips": [
    { "ip": "192.168.1.10", "userId": "userA", "netmask": "255.255.255.0" },
    { "ip": "10.0.0.5" }
  ]
}
```

#### 3. Add Whitelisted IP (Simple)

Adds the specified IP to the client's whitelist.

```bash
skill/ip_whitelist/add-ip.ts --env=<environment> --client-id=<client_id> --ip=<ip_address>
```

**Response Example:**

```
HTTP Status: 200

From chaddm/ad-astra-per-aspera, MIT.

More from chaddm/ad-astra-per-aspera