A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
class Admin::ApiController < Admin::AdminController
# Note: in the REST API, ApiKeys are referred to simply as "key"
# If we used "api_key", then our user provider would try to use the value for authentication
INDEX_LIMIT = 50
def index
offset = (params[:offset] || 0).to_i
limit = fetch_limit_from_params(default: INDEX_LIMIT, max: INDEX_LIMIT)
keys =
ApiKey
.where(hidden: false)
.includes(:user)
.includes(:created_by)
.order("revoked_at DESC NULLS FIRST, created_at DESC")
.offset(offset)
.limit(limit)
render_json_dump(
keys: serialize_data(keys, BasicApiKeySerializer),
offset: offset,
limit: limit,
)
end
def show
api_key = ApiKey.includes(:api_key_scopes).find(params[:id])
render_serialized(api_key, ApiKeySerializer, root: "key")
end
def scopes
scopes =
ApiKeyScope
.scope_mappings
.sort_by { |resource, _| resource.to_s }
.reduce({}) do |memo, (resource, actions)|
memo.tap do |m|
m[resource] = actions.map do |k, v|
{
scope_id: "#{resource}:#{k}",
key: k,
name: k.to_s.gsub("_", " "),
params: ApiKeyScope.restrictable_parameters(v),
urls: v[:urls],
}
end
end
end
render json: { scopes: scopes }
end
def update
api_key = ApiKey.find(params[:id])
ApiKey.transaction do
api_key.update!(update_params)
log_api_key(api_key, UserHistory.actions[:api_key_update], changes: api_key.saved_changes)
end
render_serialized(api_key, ApiKeySerializer, root: "key")
end
def destroy
api_key = ApiKey.find(params[:id])
ApiKey.transaction do
api_key.destroy
log_api_key(api_key, UserHistory.actions[:api_key_destroy])
end
render json: success_json
end
def create
api_key_params = update_params
validate_read_only_scopes!
api_key = ApiKey.new(api_key_params)
ApiKey.transaction do
api_key.created_by = current_user
api_key.api_key_scopes =
ApiKeyScope.build_from_params(
params.require(:key)[:scopes].to_a.map { it.try(:to_unsafe_h) || it },
)
api_key.scope_mode = params.dig(:key, :scope_mode)
if username = params.require(:key).permit(:username)[:username].presence
api_key.user = User.find_by_username(username)
raise Discourse::NotFound unless api_key.user
end
api_key.save!
log_api_key(api_key, UserHistory.actions[:api_key_create], changes: api_key.saved_changes)
end
render_serialized(api_key, ApiKeySerializer, root: "key")
end
def undo_revoke_key
api_key = ApiKey.find_by(id: params[:id])
raise Discourse::NotFound if api_key.blank?
ApiKey.transaction do
api_key.update(revoked_at: nil)
log_api_key_restore(api_key)
end
render_serialized(api_key, ApiKeySerializer)
end
def revoke_key
api_key = ApiKey.find_by(id: params[:id])
raise Discourse::NotFound if api_key.blank?
ApiKey.transaction do
api_key.update(revoked_at: Time.zone.now)
log_api_key_revoke(api_key)
end
render_serialized(api_key, ApiKeySerializer)
end
private
def validate_read_only_scopes!
return if params.dig(:key, :scope_mode) != "read_only"
raise Discourse::InvalidParameters if params.dig(:key, :scopes).blank?
end
def update_params
editable_fields = [:description]
permitted_params = params.permit(key: [*editable_fields])[:key]
raise Discourse::InvalidParameters unless permitted_params
permitted_params
end
def log_api_key(*args)
StaffActionLogger.new(current_user).log_api_key(*args)
end
def log_api_key_revoke(*args)
StaffActionLogger.new(current_user).log_api_key_revoke(*args)
end
def log_api_key_restore(*args)
StaffActionLogger.new(current_user).log_api_key_restore(*args)
end
end