enterprise-settings

APIs.ioEngineeringPlatform

Properties

Name Type Description
enterprise object
run_list array
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-enterprise-settings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/enterprise-settings",
  "title": "enterprise-settings",
  "type": "object",
  "properties": {
    "enterprise": {
      "type": "object",
      "properties": {
        "private_mode": {
          "type": "boolean"
        },
        "public_pages": {
          "type": "boolean"
        },
        "subdomain_isolation": {
          "type": "boolean"
        },
        "signup_enabled": {
          "type": "boolean"
        },
        "github_hostname": {
          "type": "string"
        },
        "identicons_host": {
          "type": "string"
        },
        "http_proxy": {
          "nullable": true,
          "type": "string"
        },
        "auth_mode": {
          "type": "string"
        },
        "expire_sessions": {
          "type": "boolean"
        },
        "admin_password": {
          "nullable": true,
          "type": "string"
        },
        "configuration_id": {
          "type": "integer"
        },
        "configuration_run_count": {
          "type": "integer"
        },
        "avatar": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "uri": {
              "type": "string"
            }
          }
        },
        "customer": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "email": {
              "type": "string"
            },
            "uuid": {
              "type": "string"
            },
            "secret_key_data": {
              "type": "string"
            },
            "public_key_data": {
              "type": "string"
            }
          }
        },
        "license": {
          "type": "object",
          "properties": {
            "seats": {
              "type": "integer"
            },
            "evaluation": {
              "type": "boolean"
            },
            "perpetual": {
              "type": "boolean"
            },
            "unlimited_seating": {
              "type": "boolean"
            },
            "support_key": {
              "type": "string"
            },
            "ssh_allowed": {
              "type": "boolean"
            },
            "cluster_support": {
              "type": "boolean"
            },
            "expire_at": {
              "type": "string"
            }
          }
        },
        "github_ssl": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "cert": {
              "nullable": true,
              "type": "string"
            },
            "key": {
              "nullable": true,
              "type": "string"
            }
          }
        },
        "ldap": {
          "type": "object",
          "properties": {
            "host": {
              "nullable": true,
              "type": "string"
            },
            "port": {
              "type": "integer"
            },
            "base": {
              "type": "array",
              "items": {}
            },
            "uid": {
              "nullable": true,
              "type": "string"
            },
            "bind_dn": {
              "nullable": true,
              "type": "string"
            },
            "password": {
              "nullable": true,
              "type": "string"
            },
            "method": {
              "type": "string"
            },
            "search_strategy": {
              "type": "string"
            },
            "user_groups": {
              "type": "array",
              "items": {}
            },
            "admin_group": {
              "nullable": true,
              "type": "string"
            },
            "virtual_attribute_enabled": {
              "type": "boolean"
            },
            "recursive_group_search": {
              "type": "boolean"
            },
            "posix_support": {
              "type": "boolean"
            },
            "user_sync_emails": {
              "type": "boolean"
            },
            "user_sync_keys": {
              "type": "boolean"
            },
            "user_sync_interval": {
              "type": "integer"
            },
            "team_sync_interval": {
              "type": "integer"
            },
            "sync_enabled": {
              "type": "boolean"
            },
            "reconciliation": {
              "type": "object",
              "properties": {
                "user": {
                  "nullable": true,
                  "type": "string"
                },
                "org": {
                  "nullable": true,
                  "type": "string"
                }
              }
            },
            "profile": {
              "type": "object",
              "properties": {
                "uid": {
                  "type": "string"
                },
                "name": {
                  "nullable": true,
                  "type": "string"
                },
                "mail": {
                  "nullable": true,
                  "type": "string"
                },
                "key": {
                  "nullable": true,
                  "type": "string"
                }
              }
            }
          }
        },
        "cas": {
          "type": "object",
          "properties": {
            "url": {
              "nullable": true,
              "type": "string"
            }
          }
        },
        "saml": {
          "type": "object",
          "properties": {
            "sso_url": {
              "nullable": true,
              "type": "string"
            },
            "certificate": {
              "nullable": true,
              "type": "string"
            },
            "certificate_path": {
              "nullable": true,
              "type": "string"
            },
            "issuer": {
              "nullable": true,
              "type": "string"
            },
            "idp_initiated_sso": {
              "type": "boolean"
            },
            "disable_admin_demote": {
              "type": "boolean"
            }
          }
        },
        "github_oauth": {
          "type": "object",
          "properties": {
            "client_id": {
              "type": "string"
            },
            "client_secret": {
              "type": "string"
            },
            "organization_name": {
              "type": "string"
            },
            "organization_team": {
              "type": "string"
            }
          }
        },
        "smtp": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "address": {
              "type": "string"
            },
            "authentication": {
              "type": "string"
            },
            "port": {
              "type": "string"
            },
            "domain": {
              "type": "string"
            },
            "username": {
              "type": "string"
            },
            "user_name": {
              "type": "string"
            },
            "enable_starttls_auto": {
              "type": "boolean"
            },
            "password": {
              "type": "string"
            },
            "discard-to-noreply-address": {
              "type": "boolean"
            },
            "support_address": {
              "type": "string"
            },
            "support_address_type": {
              "type": "string"
            },
            "noreply_address": {
              "type": "string"
            }
          }
        },
        "ntp": {
          "type": "object",
          "properties": {
            "primary_server": {
              "type": "string"
            },
            "secondary_server": {
              "type": "string"
            }
          }
        },
        "timezone": {
          "nullable": true,
          "type": "string"
        },
        "snmp": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "community": {
              "type": "string"
            }
          }
        },
        "syslog": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "server": {
              "nullable": true,
              "type": "string"
            },
            "protocol_name": {
              "type": "string"
            }
          }
        },
        "assets": {
          "nullable": true,
          "type": "string"
        },
        "pages": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            }
          }
        },
        "collectd": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "server": {
              "nullable": true,
              "type": "string"
            },
            "port": {
              "type": "integer"
            },
            "encryption": {
              "nullable": true,
              "type": "string"
            },
            "username": {
              "nullable": true,
              "type": "string"
            },
            "password": {
              "nullable": true,
              "type": "string"
            }
          }
        },
        "mapping": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "tileserver": {
              "nullable": true,
              "type": "string"
            },
            "basemap": {
              "type": "string"
            },
            "token": {
              "nullable": true,
              "type": "string"
            }
          }
        },
        "load_balancer": {
          "nullable": true,
          "type": "string"
        }
      }
    },
    "run_list": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}