# link.latr.auth.probe

> Published by [samclemente.me](https://lexicon.garden/identity/did:plc:qy5pluw2bsuq2x6albsgkvx3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qy5pluw2bsuq2x6albsgkvx3/link.latr.auth.probe)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qy5pluw2bsuq2x6albsgkvx3/link.latr.auth.probe/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qy5pluw2bsuq2x6albsgkvx3/link.latr.auth.probe/examples)

## Definitions

### `link.latr.auth.probe`

**Type**: `query`

L@tr XRPC method link.latr.auth.probe.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ok` | `boolean` | Yes |  |
| `did` | `string` (did) | Yes |  |
| `clientId` | `string` | No |  |
| `sampleCount` | `integer` | Yes |  |
| `upstreamDpop` | `boolean` | Yes |  |
| `pdsWriteThrough` | `boolean` | Yes |  |

#### Errors

- **InvalidRequest**
- **InvalidUrl**
- **AuthRequired**
- **InvalidToken**
- **InvalidDpop**
- **ClientAuthRequired**
- **SavedItemNotFound**
- **Conflict**
- **RateLimitExceeded**
- **UpstreamFailure**

## Raw Schema

```json
{
  "id": "link.latr.auth.probe",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "InvalidRequest"
        },
        {
          "name": "InvalidUrl"
        },
        {
          "name": "AuthRequired"
        },
        {
          "name": "InvalidToken"
        },
        {
          "name": "InvalidDpop"
        },
        {
          "name": "ClientAuthRequired"
        },
        {
          "name": "SavedItemNotFound"
        },
        {
          "name": "Conflict"
        },
        {
          "name": "RateLimitExceeded"
        },
        {
          "name": "UpstreamFailure"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "ok",
            "did",
            "pdsWriteThrough",
            "sampleCount",
            "upstreamDpop"
          ],
          "properties": {
            "ok": {
              "type": "boolean"
            },
            "did": {
              "type": "string",
              "format": "did"
            },
            "clientId": {
              "type": "string",
              "maxLength": 128,
              "maxGraphemes": 128
            },
            "sampleCount": {
              "type": "integer",
              "minimum": 0
            },
            "upstreamDpop": {
              "type": "boolean"
            },
            "pdsWriteThrough": {
              "type": "boolean"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [],
        "properties": {}
      },
      "description": "L@tr XRPC method link.latr.auth.probe."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```