github.com/argoproj/argo-cd/v3@v3.2.1/server/settings/settings.proto (about)

     1  syntax = "proto3";
     2  option go_package = "github.com/argoproj/argo-cd/v3/pkg/apiclient/settings";
     3  
     4  // Settings Service
     5  //
     6  // Settings Service API retrieves Argo CD settings
     7  package cluster;
     8  
     9  import "gogoproto/gogo.proto";
    10  import "google/api/annotations.proto";
    11  import "github.com/argoproj/argo-cd/v3/pkg/apis/application/v1alpha1/generated.proto";
    12  import "github.com/argoproj/argo-cd/v3/server/settings/oidc/claims.proto";
    13  
    14  // SettingsQuery is a query for Argo CD settings
    15  message SettingsQuery {
    16  }
    17  
    18  message Settings {
    19      string url = 1 [(gogoproto.customname) = "URL"];
    20      DexConfig dexConfig = 2;
    21      OIDCConfig oidcConfig = 3 [(gogoproto.customname) = "OIDCConfig"];
    22      string appLabelKey = 4;
    23      map<string, github.com.argoproj.argo_cd.v3.pkg.apis.application.v1alpha1.ResourceOverride> resourceOverrides = 5;
    24      bool statusBadgeEnabled = 6;
    25      GoogleAnalyticsConfig googleAnalytics = 7;
    26      github.com.argoproj.argo_cd.v3.pkg.apis.application.v1alpha1.KustomizeOptions kustomizeOptions = 8;
    27      // Help settings
    28      Help help = 9;
    29      repeated Plugin plugins = 10;
    30      bool userLoginsDisabled = 11;
    31      // Deprecated: use sidecar plugins instead.
    32      repeated github.com.argoproj.argo_cd.v3.pkg.apis.application.v1alpha1.ConfigManagementPlugin configManagementPlugins = 12;
    33      repeated string kustomizeVersions = 13;
    34      string uiCssURL = 14;
    35      string uiBannerContent = 15;
    36      string uiBannerURL = 16;
    37      string passwordPattern = 17;
    38      string trackingMethod = 18;
    39      bool uiBannerPermanent = 19;
    40      string uiBannerPosition = 20;
    41      string statusBadgeRootUrl = 21;
    42      bool execEnabled = 22;
    43      string controllerNamespace = 23;
    44      bool appsInAnyNamespaceEnabled = 24;
    45      bool impersonationEnabled = 25;
    46      string installationID = 26;
    47      repeated string additionalUrls = 27 [(gogoproto.customname) = "AdditionalURLs"];
    48      bool hydratorEnabled = 28;
    49  }
    50  
    51  message GoogleAnalyticsConfig {
    52      string trackingID = 1;
    53      bool anonymizeUsers = 2;
    54  }
    55  
    56  message SettingsPluginsResponse {
    57      repeated Plugin plugins = 1;
    58  }
    59  
    60  // Help settings
    61  message Help {
    62      // the URL for getting chat help, this will typically be your Slack channel for support
    63      string chatUrl = 1;
    64      // the text for getting chat help, defaults to "Chat now!"
    65      string chatText = 2;
    66      // the URLs for downloading argocd binaries
    67      map<string, string> binaryUrls = 3;
    68  }
    69  
    70  // Plugin settings
    71  message Plugin {
    72      // the name of the plugin, e.g. "kasane"
    73      string name = 1;
    74  }
    75  
    76  message DexConfig {
    77      repeated Connector connectors = 1;
    78  }
    79  
    80  message Connector {
    81      string name = 1;
    82      string type = 2;
    83  }
    84  
    85  message OIDCConfig {
    86      string name = 1;
    87      string issuer = 2;
    88      string clientID = 3 [(gogoproto.customname) = "ClientID"];
    89      string cliClientID = 4 [(gogoproto.customname) = "CLIClientID"];
    90      repeated string scopes = 5;
    91      map<string, github.com.argoproj.argo_cd.server.settings.oidc.Claim> idTokenClaims = 6 [(gogoproto.customname) = "IDTokenClaims"];
    92      bool enablePKCEAuthentication = 7;
    93  }
    94  
    95  // SettingsService
    96  service SettingsService {
    97  
    98      // Get returns Argo CD settings
    99      rpc Get(SettingsQuery) returns (Settings) {
   100          option (google.api.http).get = "/api/v1/settings";
   101      }
   102  
   103      // Get returns Argo CD plugins
   104      rpc GetPlugins(SettingsQuery) returns (SettingsPluginsResponse) {
   105          option (google.api.http).get = "/api/v1/settings/plugins";
   106      }
   107  }