# space.highport.policy

> Published by [lexicons.highport.space](https://lexicon.garden/identity/did:plc:ciygg5hma4q7ah2kxaszkyob)

✓ This is the authoritative definition for this NSID.

## Description

An identity's statement about the Highport policies; the record key sets the kind. Keyed by a deployment's application hostname, it accepts the policy version in subject and counts only while that version is current. Keyed 'self' with optOut true, it is a permanent, public request never to be served by Highport again, whichever version it names.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.policy)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.policy/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ciygg5hma4q7ah2kxaszkyob/space.highport.policy/examples)

## Definitions

### `space.highport.policy`

**Type**: `record`

**Key**: `any`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `optOut` | `boolean` | No | True, in a record keyed 'self', permanently blocks this identity from every Highport service and every site Highport hosts. Anything else (absent, false, or true under a different key) has no effect, exactly as if the record did not exist. |
| `subject` | `ref` → `com.atproto.repo.strongRef` | Yes | The Highport policy record this statement refers to. An acceptance names a versioned record (the policies hostname plus a TID) and counts only while its cid is current. An opt-out can name any published version and stays honoured after newer ones appear. |
| `createdAt` | `string` (datetime) | No | When the statement was made, by the clock of the client that made it. |

## Raw Schema

```json
{
  "id": "space.highport.policy",
  "defs": {
    "main": {
      "key": "any",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "subject"
        ],
        "properties": {
          "optOut": {
            "type": "boolean",
            "description": "True, in a record keyed 'self', permanently blocks this identity from every Highport service and every site Highport hosts. Anything else (absent, false, or true under a different key) has no effect, exactly as if the record did not exist."
          },
          "subject": {
            "ref": "com.atproto.repo.strongRef",
            "type": "ref",
            "description": "The Highport policy record this statement refers to. An acceptance names a versioned record (the policies hostname plus a TID) and counts only while its cid is current. An opt-out can name any published version and stays honoured after newer ones appear."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "When the statement was made, by the clock of the client that made it."
          }
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "An identity's statement about the Highport policies; the record key sets the kind. Keyed by a deployment's application hostname, it accepts the policy version in subject and counts only while that version is current. Keyed 'self' with optOut true, it is a permanent, public request never to be served by Highport again, whichever version it names."
}
```
