com.atproto.server.refreshSession Documentation (EN)

main procedure

Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt').

Output

Encodingapplication/json

accessJwt string Required

No description available.

active boolean Optional

No description available.

did stringdid Required

A decentralized identifier (DID).

didDoc unknown Optional

No description available.

email string Optional

No description available.

emailAuthFactor boolean Optional

No description available.

emailConfirmed boolean Optional

No description available.

handle stringhandle Required

An AT Protocol handle (e.g., alice.bsky.social).

refreshJwt string Required

No description available.

status string Optional

Hosting status of the account. If not specified, then assume 'active'.

Known values: takendown, suspended, deactivated

Errors

AccountTakedown

InvalidToken

ExpiredToken

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

{
  "type": "procedure",
  "errors": [
    {
      "name": "AccountTakedown"
    },
    {
      "name": "InvalidToken"
    },
    {
      "name": "ExpiredToken"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "accessJwt",
        "refreshJwt",
        "handle",
        "did"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "email": {
          "type": "string"
        },
        "active": {
          "type": "boolean"
        },
        "didDoc": {
          "type": "unknown"
        },
        "handle": {
          "type": "string",
          "format": "handle"
        },
        "status": {
          "type": "string",
          "description": "Hosting status of the account. If not specified, then assume 'active'.",
          "knownValues": [
            "takendown",
            "suspended",
            "deactivated"
          ]
        },
        "accessJwt": {
          "type": "string"
        },
        "refreshJwt": {
          "type": "string"
        },
        "emailConfirmed": {
          "type": "boolean"
        },
        "emailAuthFactor": {
          "type": "boolean"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Refresh an authentication session. Requires auth using the 'refreshJwt' (not the 'accessJwt')."
}