Module: Gitlab::Client::ApplicationSettings

Included in:

Gitlab::Client

Defined in:

lib/gitlab/client/application_settings.rb

Overview

Defines methods related to application settings.

See Also:

• https://docs.gitlab.com/ee/api/settings.html

Instance Method Summary

• #application_settings ⇒ Array<Gitlab::ObjectifiedHash>

  Retrives the application settings of Gitlab.

• #edit_application_settings(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

  Edit the applications settings of Gitlab.

Instance Method Details

#application_settings ⇒ Array<Gitlab::ObjectifiedHash>

Retrives the application settings of Gitlab.

Examples:

Gitlab.application_settings

Returns:

• (Array<Gitlab::ObjectifiedHash>)

# File 'lib/gitlab/client/application_settings.rb', line 13

def application_settings
  get('/application/settings')
end

#edit_application_settings(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Edit the applications settings of Gitlab.

Examples:

Gitlab.edit_application_settings({ signup_enabled: false })

Parameters:

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• :admin_notification_email (String)
• :after_sign_out_path (String)
• :after_sign_up_text (String)
• :akismet_api_key (String)
• :akismet_enabled (Boolean)
• :allow_group_owners_to_manage_ldap (Boolean)
• :allow_local_requests_from_hooks_and_services (Boolean)
• :authorized_keys_enabled (Boolean)
• :auto_devops_domain (String)
• :auto_devops_enabled (Boolean)
• :check_namespace_plan (Boolean)
• :clientside_sentry_dsn (String)
• :clientside_sentry_enabled (Boolean)
• :container_registry_token_expire_delay (Integer)
• :default_artifacts_expire_in (String)
• :default_branch_protection (Integer)
• :default_group_visibility (String)
• :default_project_visibility (String)
• :default_projects_limit (Integer)
• :default_snippet_visibility (String)
• :disabled_oauth_sign_in_sources (Array<String>)
• :domain_blacklist (Array<String>)
• :domain_blacklist_enabled (Boolean)
• :domain_whitelist (Array<String>)
• :dsa_key_restriction (Integer)
• :ecdsa_key_restriction (Integer)
• :ed25519_key_restriction (Integer)
• :elasticsearch_aws (Boolean)
• :elasticsearch_aws_access_key (String)
• :elasticsearch_aws_region (String)
• :elasticsearch_aws_secret_access_key (String)
• :elasticsearch_experimental_indexer (Boolean)
• :elasticsearch_indexing (Boolean)
• :elasticsearch_search (Boolean)
• :elasticsearch_url (String)
• :elasticsearch_limit_indexing (Boolean)
• :elasticsearch_project_ids (Array<Integer>)
• :elasticsearch_namespace_ids (Array<Integer>)
• :email_additional_text (String)
• :email_author_in_body (Boolean)
• :enabled_git_access_protocol (String)
• :enforce_terms (Boolean)
• :external_auth_client_cert (String)
• :external_auth_client_key (String)
• :external_auth_client_key_pass (String)
• :external_authorization_service_enabled (Boolean)
• :external_authorization_service_default_label (String)
• :external_authorization_service_timeout (Float) —

  float

• :external_authorization_service_url (String)
• :file_template_project_id (Integer)
• :first_day_of_week (Integer)
• :geo_status_timeout (Integer)
• :gitaly_timeout_default (Integer)
• :gitaly_timeout_fast (Integer)
• :gitaly_timeout_medium (Integer)
• :gravatar_enabled (Boolean)
• :hashed_storage_enabled (Boolean)
• :help_page_hide_commercial_content (Boolean)
• :help_page_support_url (String)
• :help_page_text (String)
• :help_text (String)
• :hide_third_party_offers (Boolean)
• :home_page_url (String)
• :housekeeping_bitmaps_enabled (Boolean)
• :housekeeping_enabled (Boolean)
• :housekeeping_full_repack_period (Integer)
• :housekeeping_gc_period (Integer)
• :housekeeping_incremental_repack_period (Integer)
• :html_emails_enabled (Boolean)
• :instance_statistics_visibility_private (Boolean)
• :import_sources (Array<String>)
• :max_artifacts_size (Integer)
• :max_attachment_size (Integer)
• :max_pages_size (Integer)
• :metrics_enabled (Boolean)
• :metrics_host (String)
• :metrics_method_call_threshold (Integer)
• :metrics_packet_size (Integer)
• :metrics_pool_size (Integer)
• :metrics_port (Integer)
• :metrics_sample_interval (Integer)
• :metrics_timeout (Integer)
• :mirror_available (Boolean)
• :mirror_capacity_threshold (Integer)
• :mirror_max_capacity (Integer)
• :mirror_max_delay (Integer)
• :pages_domain_verification_enabled (Boolean)
• :password_authentication_enabled_for_git (Boolean)
• :password_authentication_enabled_for_web (Boolean)
• :performance_bar_allowed_group_id (String)
• :performance_bar_allowed_group_path (String)
• :performance_bar_enabled (Boolean)
• :plantuml_enabled (Boolean)
• :plantuml_url (String)
• :polling_interval_multiplier (Float)
• :project_export_enabled (Boolean)
• :prometheus_metrics_enabled (Boolean)
• :pseudonymizer_enabled (Boolean)
• :recaptcha_enabled (Boolean)
• :recaptcha_private_key (String)
• :recaptcha_site_key (String)
• :repository_checks_enabled (Boolean)
• :repository_size_limit (Integer)
• :repository_storages (Array<String>)
• :require_two_factor_authentication (Boolean)
• :restricted_visibility_levels (Array<String>)
• :rsa_key_restriction (Integer)
• :send_user_confirmation_email (Boolean)
• :sentry_dsn (String)
• :sentry_enabled (Boolean)
• :session_expire_delay (Integer)
• :shared_runners_enabled (Boolean)
• :shared_runners_minutes (Integer)
• :shared_runners_text (String)
• :sign_in_text (String)
• :signin_enabled (String)
• :signup_enabled (Boolean)
• :slack_app_enabled (Boolean)
• :slack_app_id (String)
• :slack_app_secret (String)
• :slack_app_verification_token (String)
• :terminal_max_session_time (Integer)
• :terms (String)
• :throttle_authenticated_api_enabled (Boolean)
• :throttle_authenticated_api_period_in_seconds (Integer)
• :throttle_authenticated_api_requests_per_period (Integer)
• :throttle_authenticated_web_enabled (Boolean)
• :throttle_authenticated_web_period_in_seconds (Integer)
• :throttle_authenticated_web_requests_per_period (Integer)
• :throttle_unauthenticated_enabled (Boolean)
• :throttle_unauthenticated_period_in_seconds (Integer)
• :throttle_unauthenticated_requests_per_period (Integer)
• :two_factor_grace_period (Integer)
• :unique_ips_limit_enabled (Boolean)
• :unique_ips_limit_per_user (Integer)
• :unique_ips_limit_time_window (Integer)
• :usage_ping_enabled (Boolean)
• :user_default_external (Boolean)
• :user_oauth_applications (Boolean)
• :user_show_add_ssh_key_message (Boolean)
• :version_check_enabled (Boolean)
• :local_markdown_version (Integer)
• :geo_node_allowed_ips (String)

Returns:

• (Array<Gitlab::ObjectifiedHash>)

# File 'lib/gitlab/client/application_settings.rb', line 168

def edit_application_settings(options = {})
  put('/application/settings', body: options)
end