com.atproto.server.createSession

atproto-lexicons.bsky.social

Documentation

Create an authentication session.

main procedure

Create an authentication session.

Input

Encodingapplication/json
allowTakendown boolean Optional

When true, instead of throwing error for takendown accounts, a valid response with a narrow scoped token will be returned

authFactorToken string Optional

No description available.

identifier string Required

Handle or other identifier supported by the server for the authenticating user.

password string Required

No description available.

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

If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.

Known values: takendown, suspended, deactivated

Errors

AccountTakedown
AuthFactorTokenRequired
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",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "identifier",
        "password"
      ],
      "properties": {
        "password": {
          "type": "string"
        },
        "identifier": {
          "type": "string",
          "description": "Handle or other identifier supported by the server for the authenticating user."
        },
        "allowTakendown": {
          "type": "boolean",
          "description": "When true, instead of throwing error for takendown accounts, a valid response with a narrow scoped token will be returned"
        },
        "authFactorToken": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AccountTakedown"
    },
    {
      "name": "AuthFactorTokenRequired"
    }
  ],
  "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": "If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted.",
          "knownValues": [
            "takendown",
            "suspended",
            "deactivated"
          ]
        },
        "accessJwt": {
          "type": "string"
        },
        "refreshJwt": {
          "type": "string"
        },
        "emailConfirmed": {
          "type": "boolean"
        },
        "emailAuthFactor": {
          "type": "boolean"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Create an authentication session."
}

Lexicon Garden

@