Accounts

Connect a PieFed account using instance credentials

post/accounts/piefed/login

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/accounts/piefed/login
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Request body

$schemastring uri

A URL to the JSON Schema for this object.

channelstring

PeerTube channel to connect (required when the account owns several)

instance_urlstring required

Fediverse instance URL

intent'production' | 'certification_test'

Typed execution intent; certification_test requires an unscoped instance administrator

passwordstring required

Instance password (exchanged once, never stored)

usernamestring required

Instance username

workspace_idstring required

Workspace ID

Example request

{
  "$schema": "https://example.com/api/v1/schemas/FediverseLoginInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

account_idstring required

OpenPost destination account ID

account_idsstring[] nullable required

All connected OpenPost account IDs

connection_idstring

Pending selection ID for the channel picker

open_fresh_composerboolean required

Whether this is the Workspace's first connected destination

selection_requiredboolean

True when the caller must complete channel selection

workspace_idstring required

Workspace receiving the connected destination

Example response

{
  "$schema": "https://example.com/api/v1/schemas/FediverseLoginResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.