userId required
string
http://localhost:8080/api /integrations/clients
Get a user's details path Parameters userId required
string
The ID of the user to find
+
get /integrations/moderation/chat/user/{userId} http://localhost:8080/api /integrations/moderation/chat/user/{userId}
Response samples Content type application/json
Copy
Expand all Collapse all { "messages" :
[ { "timestamp" : "string" ,
"type" : "string" ,
"id" : "string" ,
"hiddenAt" : "string" ,
"clientId" : 0 ,
"body" : "string"
} ] }
Get a user's details path Parameters userId required
string
The ID of the user to find
Responses 200 User information
@@ -2479,7 +2503,7 @@ The APIs used to configure the Owncast server, as well as power the web admin in
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">
Unexpected error
get /moderation/chat/user/{userId} http://localhost:8080/api /moderation/chat/user/{userId}
Response samples Content type application/json
Copy
Expand all Collapse all { "messages" :
[ { "timestamp" : "string" ,
"type" : "string" ,
"id" : "string" ,
"hiddenAt" : "string" ,
"clientId" : 0 ,
"body" : "string"
} ] }
Begins auth flow Request Body schema: application/json
Responses 200 http://localhost:8080/api /moderation/chat/user/{userId}
Response samples Content type application/json
Copy
Expand all Collapse all { "messages" :
[ { "timestamp" : "string" ,
"type" : "string" ,
"id" : "string" ,
"hiddenAt" : "string" ,
"clientId" : 0 ,
"body" : "string"
} ] }
Begins auth flow Request Body schema: application/json
Responses 400 Bad request
@@ -2489,13 +2513,13 @@ The APIs used to configure the Owncast server, as well as power the web admin in
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">
Unexpected error
post /auth/indieauth http://localhost:8080/api /auth/indieauth
Request samples Content type application/json
Response samples Content type application/json
Handle the redirect from an IndieAuth server to continue the auth flow query Parameters state required
code required
Responses 307 http://localhost:8080/api /auth/indieauth
Request samples Content type application/json
Response samples Content type application/json
Handle the redirect from an IndieAuth server to continue the auth flow query Parameters state required
code required
get /auth/indieauth/callback http://localhost:8080/api /auth/indieauth/callback
Response samples Content type application/json
{ "message" : "string" ,
"success" : true
}
Handles the IndieAuth auth endpoint query Parameters client_id required
redirect_uri required
code_challenge required
state required
code required
Responses 200 http://localhost:8080/api /auth/indieauth/callback
Response samples Content type application/json
{ "message" : "string" ,
"success" : true
}
Handles the IndieAuth auth endpoint query Parameters client_id required
redirect_uri required
code_challenge required
state required
code required
Responses 307 Redirected to redirect URI
@@ -2505,7 +2529,7 @@ The APIs used to configure the Owncast server, as well as power the web admin in
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">
Internal Server Error
get /auth/provider/indieauth http://localhost:8080/api /auth/provider/indieauth
Response samples Content type application/json
Copy
Expand all Collapse all
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
Copy
Expand all Collapse all
Handles IndieAuth from form submission Request Body schema: application/x-www-form-urlencoded Form submission from IndieAuth
code redirect_uri client_id codeVerifier
Responses 200 IndieAuth flow concluded
@@ -2513,7 +2537,7 @@ The APIs used to configure the Owncast server, as well as power the web admin in
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">
Bad request
post /auth/provider/indieauth http://localhost:8080/api /auth/provider/indieauth
Response samples Content type application/json
Example IndieAuthResponse IndieAuthServerProfileResponse IndieAuthResponse Copy
Expand all Collapse all
Register a Fediverse OTP request Request Body schema: application/json
Responses 200 http://localhost:8080/api /auth/provider/indieauth
Response samples Content type application/json
Example IndieAuthResponse IndieAuthServerProfileResponse IndieAuthResponse Copy
Expand all Collapse all
Register a Fediverse OTP request Request Body schema: application/json
Responses 400 Bad request
@@ -2521,7 +2545,7 @@ The APIs used to configure the Owncast server, as well as power the web admin in
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">
Unauthorized
post /auth/fediverse http://localhost:8080/api /auth/fediverse
Request samples Content type application/json
Response samples Content type application/json
{ "message" : "string" ,
"success" : true
}
Verify Fediverse OTP code Request Body schema: application/json
Responses 200 http://localhost:8080/api /auth/fediverse
Request samples Content type application/json
Response samples Content type application/json
{ "message" : "string" ,
"success" : true
}
Verify Fediverse OTP code Request Body schema: application/json
Responses 400 Bad request
@@ -2529,7 +2553,7 @@ The APIs used to configure the Owncast server, as well as power the web admin in
" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv">
Forbidden
post /auth/fediverse/verify http://localhost:8080/api /auth/fediverse/verify
Request samples Content type application/json
Response samples Content type application/json
{ "message" : "string" ,
"success" : true
}
http://localhost:8080/api /auth/fediverse/verify
Request samples Content type application/json
Response samples Content type application/json
{ "message" : "string" ,
"success" : true
}
RegisterAnonymousChatUserOptions Responses 204 No Content
@@ -4591,7 +4615,7 @@ The APIs used to configure the Owncast server, as well as power the web admin in
" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs">
Localhost port 8080
http://localhost:8080/api /integrations/clients