# online.fg-goose.gsb.openSession

> Published by [ember.delve.town](https://lexicon.garden/identity/did:plc:6amo7col5h4ciq2gpm5eur7b)

✓ This is the authoritative definition for this NSID.

## Description

Open the issuer's scratch world through world-scratch. Method-bound service auth; response only, never a repository record.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:6amo7col5h4ciq2gpm5eur7b/online.fg-goose.gsb.openSession)
- [Documentation](https://lexicon.garden/lexicon/did:plc:6amo7col5h4ciq2gpm5eur7b/online.fg-goose.gsb.openSession/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:6amo7col5h4ciq2gpm5eur7b/online.fg-goose.gsb.openSession/examples)

## Definitions

### `online.fg-goose.gsb.openSession#fork`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `height` | `integer` | No |  |
| `world` | `string` | No |  |

### `online.fg-goose.gsb.openSession`

**Type**: `procedure`

Open the issuer's scratch world through world-scratch. Method-bound service auth; response only, never a repository record.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `from` | `ref` → `#fork` | No |  |
| `name` | `string` | Yes |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `expires` | `integer` | Yes | Home-world clock minute at which it is discarded if idle. |
| `session` | `string` | Yes | `scratch/<name>`. |

#### Errors

- **AuthRequired**
- **InvalidToken**
- **InvalidRequest**
- **RateLimitExceeded**
- **RecordNotFound**
- **HostUnavailable**

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "fork": {
      "properties": {
        "height": {
          "minimum": 1,
          "type": "integer"
        },
        "world": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "main": {
      "description": "Open the issuer's scratch world through world-scratch. Method-bound service auth; response only, never a repository record.",
      "errors": [
        {
          "name": "AuthRequired"
        },
        {
          "name": "InvalidToken"
        },
        {
          "name": "InvalidRequest"
        },
        {
          "name": "RateLimitExceeded"
        },
        {
          "name": "RecordNotFound"
        },
        {
          "name": "HostUnavailable"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "from": {
              "ref": "#fork",
              "type": "ref"
            },
            "name": {
              "maxLength": 32,
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "name"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "expires": {
              "description": "Home-world clock minute at which it is discarded if idle.",
              "minimum": 0,
              "type": "integer"
            },
            "session": {
              "description": "`scratch/<name>`.",
              "type": "string"
            }
          },
          "required": [
            "session",
            "expires"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "description": "Open the issuer's scratch world through world-scratch. Method-bound service auth; response only, never a repository record.",
  "id": "online.fg-goose.gsb.openSession",
  "lexicon": 1
}
```