Arminius Admin API (1.0.0)

Download OpenAPI specification:

License: Apache-2.0

API specification for the Arminius Admin endpoints.

Admin

Administrative operations and server management for the Arminius server.

Fetches a paginated, filterable, and sortable list of rooms. Requires an authenticated session with administrative privileges.

bearerAuth

search_term	string Optional search term to filter the results.
limit	integer >= 1 The maximum number of results to return.
offset	integer >= 0 The number of results to skip for pagination.
direction	string Default: "asc" Enum: "asc" "desc" The direction to sort the results (Ascending or Descending).
order_by	string Default: "room_id" Value: "room_id" Sort the results by this column.

Content type

application/json

[{"room_id": "!room123:example.com",
"room_version": "11"
}
]

Fetches a paginated, filterable, and sortable list of users. Requires an authenticated session with administrative privileges.

bearerAuth

search_term	string Optional search term to filter the results.
limit	integer >= 1 The maximum number of results to return.
offset	integer >= 0 The number of results to skip for pagination.
direction	string Default: "asc" Enum: "asc" "desc" The direction to sort the results (Ascending or Descending).
order_by	string Default: "user_id" Value: "user_id" The column to sort the results by.

Content type

application/json

[{"user_id": "@example:example.org",
"display_name": "Alice",
"avatar_id": "string"
}
]

Triggers a rotation of the server keys. Requires an authenticated session with administrative privileges.

bearerAuth

Content type

application/json

{"errcode": "M_UNAUTHORIZED",
"error": "User is unauthorized to perform the action."
}