Skip to content

com.atproto.server.getSession

Lexicon Version: 1

Type: query

Get information about the current auth session. Requires auth.

Parameters: (None defined)

Output:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
handlestringFormat: handle
didstringFormat: did
emailstring
emailConfirmedboolean
emailAuthFactorboolean
didDocunknown
activeboolean
statusstringIf 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

{
"lexicon": 1,
"id": "com.atproto.server.getSession",
"defs": {
"main": {
"type": "query",
"description": "Get information about the current auth session. Requires auth.",
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"handle",
"did"
],
"properties": {
"handle": {
"type": "string",
"format": "handle"
},
"did": {
"type": "string",
"format": "did"
},
"email": {
"type": "string"
},
"emailConfirmed": {
"type": "boolean"
},
"emailAuthFactor": {
"type": "boolean"
},
"didDoc": {
"type": "unknown"
},
"active": {
"type": "boolean"
},
"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"
]
}
}
}
}
}
}
}