Class: Crm::ApiTokensController

Inherits:
CrmController show all
Defined in:
app/controllers/crm/api_tokens_controller.rb

Overview

Manages API tokens and OAuth tokens for employee accounts.
Tokens are used for MCP (Model Context Protocol) and other API integrations.

The index action shows a unified view of both:

  • ApiAuthentication tokens (manual, for Cursor/programmatic access)
  • Doorkeeper OAuth tokens (from Claude Desktop/native MCP clients)

Constant Summary

Constants included from Controllers::ReferenceFindable

Controllers::ReferenceFindable::ID_EMBEDDED_PATTERNS

Constants included from Controllers::AnalyticsEvents

Controllers::AnalyticsEvents::MAX_QUEUED_EVENTS, Controllers::AnalyticsEvents::SESSION_KEY

Constants included from Controllers::ErrorRendering

Controllers::ErrorRendering::NON_CONTENT_PATH_PREFIXES

Instance Method Summary collapse

Methods inherited from CrmController

#access_denied, #context_id, #context_object, #crm_home_path, #current_ability, #default_url_options, #download_temp, #get_tempfile_path_for_download, #init_status_job_collector, #initialize_crm_lazy_chunks, #persist_enqueued_status_jobs, #record_not_found, #redirect_to_job_or_fallback, #render_edit_action, #set_context, #set_download_path, #stash_file_for_temp_download, #sync_admin_presence_cookie, #touch_employee_last_seen

Methods inherited from ApplicationController

#account_impersonated?, #add_to_flash, #after_sign_in_path_for, #bypass_forgery_protection?, #chat_enabled?, #cloudflare_cleared?, #default_catalog, #default_url_options, #enable_turbo_frames, #find_publication, #fix_invalid_accept_header, #init_js_utils, #is_globals_call?, #layout_by_resource, #locale_store, #redirect_to, #require_employee_for_crm, #set_base_host, #set_real_ip, #set_report_errors_for, #should_render_layout?, #skip_layout_for_turbo_frame?, #stamp_impersonation_context, #tab_frame_breakout_request?, #warmlyyours_canada_ip?, #warmlyyours_ip?, #y

Methods included from Controllers::ReturnPathHandling

#check_for_return_path, #redirect_to_return_path_or_default

Methods included from Controllers::AnalyticsEvents

#consume_queued_analytics_events, #registration_lead_type, #track_event

Methods included from Controllers::DeviceDetection

#device_detector, #is_ie?

Methods included from Controllers::SubdomainDetection

#is_crm_request?, #is_www_request?, #json_request?

Methods included from Controllers::TurboSafeRedirect

#redirect_to

Methods included from Controllers::TrackingDetection

#bot_request?, #gdpr_country?, #gdpr_country_data, #prevent_bots, #set_tracking_cookie, #track_visitor?

Methods included from Controllers::AcceleratedFileSending

#send_file_accelerated, #send_upload_accelerated

Methods included from Controllers::ErrorRendering

#excp_string, #mail_to_for_error_reporting, #render_400, #render_404, #render_406, #render_410, #render_500, #render_invalid_authenticity_token, #render_ip_spoof_error, #render_unpermitted_parameters, #safe_referer_or_fallback

Methods included from Controllers::TurnstileVerification

#load_turnstile_script_tag, #turnstile_lazy_widget, #turnstile_script_tag, #turnstile_widget, #validate_turnstile!

Methods included from Controllers::CloudflareCaching

edge_cached, #edge_cached_action?, #reset_cloudflare_cache, #set_cloudflare_cache, #skip_edge_cache!, #skip_session

Methods included from Controllers::Webpackable

#preload_webpack_fonts, #webpack_css_include, #webpack_css_url, #webpack_js_include, #wpd_is_running?

Methods included from Controllers::Localizable

#cloudflare_country_locale, #determine_request_locale, #geocoder_locale, #guest_user_locale_check, #locale_optional_www_auth_path?, #param_locale, #set_locale, #set_request_locale, #skip_localization?, #warmlyyours_ip_locale

Methods included from Controllers::Authenticable

#access_denied, #authenticate_account, #authenticate_account!, #authenticate_account_from_login_token!, #check_is_a_manager, #check_is_a_sales_manager, #check_is_an_admin, #check_is_an_employee, #check_party, #clear_mismatched_guest_user, #create_guest_user, #credentials?, #current_or_guest_user, #current_or_guest_user_id_read_only, #current_user, #devise_mapping, #fully_logged_in?, #generate_bot_id, #guest_user, #identifiable?, #init_current_user, #initialize_guest, #load_context_user, #logging_in, #resource, #resource_name, #restrict_access_for_non_employees, #scrubbed_request_path, #user_object, #warn_on_session_guest_id_leak

Methods included from UrlsHelper

#catalog_breadcrumb_links, #catalog_link, #catalog_link_for_product_line, #catalog_link_for_sku, #cms_link, #delocalized_path, #path_to_sales_product_sku, #path_to_sales_product_sku_for_product_line, #path_to_sales_product_sku_for_product_line_slug, #product_line_from_catalog_link, #protocol_neutral_url, #sanitize_external_url, #valid_external_url?

Instance Method Details

#create ⇒ void

This method returns an undefined value.

POST /employees/:employee_id/api_tokens — creates an API token.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 48

def create
  authorize! :manage_api_tokens, @employee

  @token = @employee..api_authentications.build(token_params)

  if @token.save
    # Store the full token in flash for one-time display
    flash[:new_token] = @token.api_authentication_token
    flash[:new_token_id] = @token.id
    redirect_to employee_api_tokens_path(@employee),
                notice: 'API token created successfully. Copy it now - it won\'t be shown again!'
  else
    render :new, status: :unprocessable_content
  end
end

#edit ⇒ void

This method returns an undefined value.

GET /employees/:employee_id/api_tokens/:id/edit — edit form for an
existing token.



41
42
43
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 41

def edit
  authorize! :manage_api_tokens, @employee
end

#index ⇒ void

This method returns an undefined value.

GET /employees/:employee_id/api_tokens — an employee's API/OAuth tokens.



17
18
19
20
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 17

def index
  authorize! :manage_api_tokens, @employee
  @tokens = build_unified_tokens
end

#new ⇒ void

This method returns an undefined value.

GET /employees/:employee_id/api_tokens/new — blank API token form.



32
33
34
35
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 32

def new
  authorize! :manage_api_tokens, @employee
  @token = @employee..api_authentications.build
end

#revoke ⇒ void

This method returns an undefined value.

POST /employees/:employee_id/api_tokens/:id/revoke — revokes an API token.



82
83
84
85
86
87
88
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 82

def revoke
  authorize! :manage_api_tokens, @employee

  @token.revoke!
  redirect_to employee_api_tokens_path(@employee),
              notice: "Token '#{@token.name || 'Unnamed'}' has been revoked."
end

#revoke_oauth ⇒ Object

Revoke an OAuth access token

Raises:

  • (ActiveRecord::RecordNotFound) 


91
92
93
94
95
96
97
98
99
100
101
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 91

def revoke_oauth
  authorize! :manage_api_tokens, @employee

  oauth_token = Doorkeeper::AccessToken.find(params[:id])
  raise ActiveRecord::RecordNotFound unless oauth_token.resource_owner_id == @employee.

  oauth_token.revoke
  app_name = oauth_token.application&.name || 'OAuth Token'
  redirect_to employee_api_tokens_path(@employee),
              notice: "OAuth token '#{app_name}' has been revoked."
end

#show ⇒ void

This method returns an undefined value.

GET /employees/:employee_id/api_tokens/:id — a single API token.



25
26
27
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 25

def show
  authorize! :manage_api_tokens, @employee
end

#update ⇒ void

This method returns an undefined value.

PATCH/PUT /employees/:employee_id/api_tokens/:id — updates a token's
name/permitted services.



68
69
70
71
72
73
74
75
76
77
 
# File 'app/controllers/crm/api_tokens_controller.rb', line 68

def update
  authorize! :manage_api_tokens, @employee

  if @token.update(update_token_params)
    redirect_to employee_api_tokens_path(@employee),
                notice: "Token '#{@token.name || 'Unnamed'}' updated successfully."
  else
    render :edit, status: :unprocessable_content
  end
end