diff --git a/docs/api/index.html b/docs/api/index.html index 5346a5adc..0c5e1af43 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -413,7 +413,7 @@ data-styled.g137[id="sc-kBpWFy"]{content:"eDlXyu,"}/*!sc*/ -

No Content

Internal

http://localhost:8080/api/integrations/clients

Get a user's details

Authorizations:
BearerAuth
path Parameters
userId
required
string

The ID of the user to find

+

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "connectedClients": [
    ],
  • "messages": [
    ]
}

Internal

These APIs are used internally for the operation of the application. They should not be used by third party clients or tooling, as they may require sharing your admin password, and additionally may change at any time.

Get the status of the server

Responses

Get a user's details

path Parameters
userId
required
string
http://localhost:8080/api/integrations/clients

Get a user's details

Authorizations:
BearerAuth
path Parameters
userId
required
string

The ID of the user to find

+

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "connectedClients": [
    ],
  • "messages": [
    ]
}

Get a user's details

path Parameters
userId
required
string

The ID of the user to find

query Parameters
accessToken
required
string

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "connectedClients": [
    ],
  • "messages": [
    ]
}

Begins auth flow

query Parameters
accessToken
required
string
Request Body schema: application/json
authHost
string

Responses

Response samples

Content type
application/json
{
  • "user": {
    },
  • "connectedClients": [
    ],
  • "messages": [
    ]
}

Begins auth flow

query Parameters
accessToken
required
string
Request Body schema: application/json
authHost
string

Responses

Request samples

Content type
application/json
{
  • "authHost": "string"
}

Response samples

Content type
application/json
{
  • "redirect": "string"
}

Handle the redirect from an IndieAuth server to continue the auth flow

query Parameters
state
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "authHost": "string"
}

Response samples

Content type
application/json
{
  • "redirect": "string"
}

Handle the redirect from an IndieAuth server to continue the auth flow

query Parameters
state
required
string
code
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Handles the IndieAuth auth endpoint

Authorizations:
BasicAuth
query Parameters
client_id
required
string
redirect_uri
required
string
code_challenge
required
string
state
required
string
code
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Handles the IndieAuth auth endpoint

Authorizations:
BasicAuth
query Parameters
client_id
required
string
redirect_uri
required
string
code_challenge
required
string
state
required
string
code
required
string

Responses

Response samples

Content type
application/json
{
  • "me": "string",
  • "profile": {
    },
  • "error": "string",
  • "errorDescription": "string"
}

Handles IndieAuth from form submission

Request Body schema: application/x-www-form-urlencoded
http://localhost:8080/api/auth/provider/indieauth

Response samples

Content type
application/json
{
  • "me": "string",
  • "profile": {
    },
  • "error": "string",
  • "errorDescription": "string"
}

Handles IndieAuth from form submission

Request Body schema: application/x-www-form-urlencoded

Form submission from IndieAuth

code
string
redirect_uri
string
client_id
string
codeVerifier
string

Responses

Response samples

Content type
application/json
Example
{
  • "me": "string",
  • "profile": {
    },
  • "error": "string",
  • "errorDescription": "string"
}

Register a Fediverse OTP request

query Parameters
accessToken
required
string
Request Body schema: application/json
account
string

Responses

Response samples

Content type
application/json
Example
{
  • "me": "string",
  • "profile": {
    },
  • "error": "string",
  • "errorDescription": "string"
}

Register a Fediverse OTP request

query Parameters
accessToken
required
string
Request Body schema: application/json
account
string

Responses

Request samples

Content type
application/json
{
  • "account": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Verify Fediverse OTP code

Request Body schema: application/json
code
string

Responses

Request samples

Content type
application/json
{
  • "account": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Verify Fediverse OTP code

Request Body schema: application/json
code
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Objects

http://localhost:8080/api/auth/fediverse/verify

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "success": true
}

Objects

Object definitions

RegisterAnonymousChatUserOptions

Responses