com.atproto.account Lexicon#

Definitions related to account-management in ATP services.


com.atproto.account.create#

RPC procedure Create an account.

Parameters:

  • Encoding: application/json
  • Schema:
export interface Parameters {
  email: string;
  handle: string;
  inviteCode?: string;
  password: string;
  recoveryKey?: string;
}

Response:

  • Encoding: application/json
  • Schema:
export interface Response {
  accessJwt: string;
  refreshJwt: string;
  handle: string;
  did: string;
  declarationCid: string;
}

com.atproto.account.createInviteCode#

RPC procedure Create an invite code.

Parameters:

  • Encoding: application/json
  • Schema:
export interface Parameters {
  useCount: number;
}

Response:

  • Encoding: application/json
  • Schema:
export interface Response {
  code: string;
}

com.atproto.account.delete#

RPC procedure Delete an account.

Parameters:

  • Schema:
export interface Parameters {
  [k: string]: unknown;
}

Response:

  • Schema:
export interface Response {
  [k: string]: unknown;
}

com.atproto.account.get#

RPC query Get information about an account.

Response:

  • Schema:
export interface Response {
  [k: string]: unknown;
}

com.atproto.account.requestPasswordReset#

RPC procedure Initiate a user account password reset via email

Parameters:

  • Encoding: application/json
  • Schema:
export interface Parameters {
  email: string;
}

Response:

  • Encoding: application/json
  • Schema:
export interface Response {}

com.atproto.account.resetPassword#

RPC procedure Reset a user account password using a token

Parameters:

  • Encoding: application/json
  • Schema:
export interface Parameters {
  token: string;
  password: string;
}

Response:

  • Encoding: application/json
  • Schema:
export interface Response {}

See what's next.Join the private beta.

The AT Protocol will launch soon.
Join the waitlist to try the beta before it's publicly available.

Join the waitlist