mod_http_admin_api/openapi.yaml

3.0.1
Prosody administration API
Prosody administration API
developers@prosody.im
MIT
https://prosody.im/source/mit
1.0.0
/admin_api
user
Manage user accounts
invite
Pending invitations
group
User groups
user
List users
Returns an array of users.
listUsers
successful operation
/users/{username}
user
Get user by user name
getUserByName
username
path
The name that needs to be fetched
true
string
successful operation
Invalid username supplied
User not found
user
Updated user
Update a user
updateUser
username
path
user that need to be updated
true
string
Updated user object
true
Invalid user supplied
User not found
body
user
Delete user
Delete a user account
deleteUser
username
path
The name that needs to be deleted
true
string
Invalid username supplied
User not found
/users/{username}/groups
user
List groups that user is a member of
getUserGroups
username
path
The name of the user to fetch
true
string
Returns an array of group IDs that the user belongs to
array
string
Invalid username supplied
User not found
/users/{username}/debug
user
Get user debug info
getUserDebugInfo
username
path
The name of the user to fetch
true
string
successful operation
Invalid username supplied
User not found
invite
List invites
Returns an array of users.
listInvites
successful operation
invite
Create invitation to register a new account
Creates a new invitation
createInviteForAccount
false
successful operation
invite
Create group invitation
createInviteForGroup
false
successful operation
invite
Create account reset invitation
createInviteForAccountReset
true
successful operation
/invites/{id}
invite
Get invite by id
getInviteById
id
path
The id of the invite to fetch
true
string
successful operation
Invite not found
invite
Delete invite
Delete a pending invite
deleteInvite
id
path
The id of the invite to be deleted
true
string
Invite not found
group
List groups
Returns an array of groups.
listGroups
successful operation
group
Create group
Creates a new user group
createGroup
true
successful operation
/groups/{id}
group
Get group by id
getGroupById
id
path
The id of the group to fetch
true
string
successful operation
Group not found
group
Delete group
Delete a group (does not delete users or existing subscriptions)
deleteGroup
id
path
The id of the group to be deleted
true
string
Group not found
/groups/{id}/members/{username}
group
Create group membership
addGroupMember
id
path
The id of the group to modify
true
string
username
path
The username to add to the group
true
string
successful operation
Group not found
group
Delete a group membership
deleteGroupMember
id
path
The id of the group to modify
true
string
username
path
The username to remove from the group
true
string
successful operation
Group not found
server
Get information about the server
getServerInfo
successful operation
server
Get metrics from the running server
getServerMetrics
successful operation
server
Post an announcement to some or all users
postServerAnnouncement
Announcement parameters
true
Announcement has been sent
array
object
string
XMPP username of the user
string
Display name of the user
true
string
Primary role of the user
true
array
List of additional roles assigned to the user
string
array
List of roles assigned to the user (Legacy)
true
string
string
Optional email address for the user (NYI)
true
string
Optional phone number for the user (NYI)
true
array
List of group IDs user is a member of
string
Group ID
array
object
string
Unique ID of the invite
string
The type (action) of the invite (register, roster, etc.)
boolean
Whether the invite may be used more than once (until expiry or revocation)
string
(Optional) JID of the inviter
true
string
The JID of the invite, interpretation varies based by invite
type
string
Invite token
string
XMPP URI of the invite
string
HTTPS URL of invite page (use in preference to XMPP URI when available)
true
integer
Unix timestamp of invite creation
integer
Unix timestamp of invite expiration
array
Array of group IDs that an accepting user will be added to
string
Group ID
string
boolean
object
string
Optionally restrict the registered account to the specified username
true
number
The time in seconds that the invitation will be valid for (uses a sensible default if not provided).
true
array
true
string
object
number
Specify that the invitation will only be valid for the specified number of seconds. If not provided, the invitation will be valid until it is manually deleted.
array
true
string
object
string
number
Time in seconds that the link will be valid. Defaults to 24 hours.
true
object
string
boolean
Create a MUC associated with the group
object
string
id of the group
string
Display name of the group
string
true
JID of the associated MUC, if any.
array
object
array
object
string
string
true
integer
object
boolean
boolean
boolean
true
object
boolean
boolean
boolean
boolean
boolean
boolean
boolean
object
integer
true
integer
true
object
true
string
integer
true
object
integer
string
string
number
object
object
boolean
boolean
array
object
integer
true
boolean
boolean
object
Information about the current server
string
A friendly name for the service
string
A human-readable version string
object
A selection of instantaneous metrics of the prosody server
integer
RSS in bytes
object
CPU time counter
value
since
number
The metric epoch as UNIX timestamp
number
Seconds of CPU time used since the metric epoch
integer
Number of active c2s sessions
integer
Disk space used by uploaded files
object
An announcemen to post to users on the server
body
recipients
string
The message body to send
List of recipients or one of the strings "online" or "all"
author	Matthew Wild <mwild1@gmail.com>
date	Wed, 05 Apr 2023 19:39:53 +0100
parents	f60287bba62c
children	2aa66e928aa0