Variable ldap_server_configConst

Type Declaration

• ReadonlyallowWebServiceAccess: true

• Readonlyattributes: { update_synch: true }

• Readonlyextends: "sys_metadata"

• Readonlylabel: "LDAP Server"

• Readonlyname: "ldap_server_config"

• Readonlyschema: {
      active: Typed<
          boolean,
          {
              default: true;
              label: [
                  {
                      hint: "Server is active";
                      label: "Active";
                      language: "en";
                      plural: "Active";
                  },
              ];
          },
      >;
      attributes: Typed<
          string,
          {
              label: [
                  {
                      hint: "Attributes that you want to retrieve from LDAP";
                      label: "Attributes";
                      language: "en";
                      plural: "Attributes";
                  },
              ];
              maxLength: 4000;
          },
      >;
      authenticate: Typed<
          boolean,
          {
              default: true;
              label: [
                  {
                      hint: "Use LDAP authentication for users from this server";
                      label: "Authenticate";
                      language: "en";
                      plural: "Authenticates";
                  },
              ];
          },
      >;
      connect_timeout: Typed<
          number,
          {
              default: "10";
              label: [
                  {
                      hint: "Number of seconds before a timeout on connection requests";
                      label: "Connect timeout";
                      language: "en";
                      plural: "Connect timeouts";
                  },
              ];
          },
      >;
      dn: Typed<
          string,
          {
              label: [
                  {
                      hint: "DN used for logging in to LDAP server";
                      label: "Login distinguished name";
                      language: "en";
                      plural: "Login distinguished names";
                  },
              ];
              maxLength: 100;
          },
      >;
      dn_field: Typed<
          string,
          {
              attributes: { allow_null: true; table: "sys_user" };
              label: [
                  {
                      hint: "Field name containing DN for user for LDAP authentication";
                      label: "DN Field";
                      language: "en";
                      plural: "DN Fields";
                  },
              ];
          },
      >;
      listen_interval: Typed<
          number,
          {
              default: "5";
              label: [
                  {
                      hint: "Number of minutes between processing of LDAP server changes";
                      label: "Listen interval";
                      language: "en";
                      plural: "Listen intervals";
                  },
              ];
          },
      >;
      listener: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Start a listener for this server";
                      label: "Listener";
                      language: "en";
                      plural: "Listeners";
                  },
              ];
          },
      >;
      map: Typed<
          | string
          | Record<"sys_impex_map">
          | ExplicitKey<"sys_impex_map">
          | TableBrand<"sys_impex_map">,
          {
              attributes: { encode_utf8: false };
              label: "Map";
              referenceTable: "sys_impex_map";
          },
      >;
      mid_server: Typed<
          | string
          | Record<"ecc_agent">
          | ExplicitKey<"ecc_agent">
          | TableBrand<"ecc_agent">,
          {
              attributes: { encode_utf8: false };
              label: [
                  {
                      hint: "Specify a MID server to use for this LDAP Server";
                      label: "MID Server";
                      language: "en";
                      plural: "MID Servers";
                  },
              ];
              referenceTable: "ecc_agent";
          },
      >;
      name: Typed<string, { label: "Name"; unique: true }>;
      paging: Typed<
          boolean,
          {
              default: true;
              label: [
                  {
                      hint: "Use LDAP paging service for getting results";
                      label: "Paging";
                      language: "en";
                      plural: "Pagings";
                  },
              ];
          },
      >;
      password: Typed<
          string,
          {
              attributes: { is_legacy_password2: true; no_data_replicate: true };
              label: [
                  {
                      hint: "Password used for logging in to LDAP server";
                      label: "Login password";
                      language: "en";
                      plural: "Login passwords";
                  },
              ];
          },
      >;
      rdn: Typed<
          string,
          {
              label: [
                  {
                      hint: "Starting point for searching (relative distinguished name)";
                      label: "Starting search directory";
                      language: "en";
                      plural: "Starting search directories";
                  },
              ];
              maxLength: 100;
          },
      >;
      read_timeout: Typed<
          number,
          {
              default: "30";
              label: [
                  {
                      hint: "Number of seconds before a timeout on read requests";
                      label: "Read timeout";
                      language: "en";
                      plural: "Read timeouts";
                  },
              ];
          },
      >;
      server_url: Typed<
          string,
          {
              dynamicValueDefinitions: {
                  calculatedValue: "new LDAPURLUtils().getAccumURL(current.sys_id);";
                  type: "calculated_value";
              };
              label: [
                  {
                      hint: "URL to connect to server";
                      label: "Server URL";
                      language: "en";
                      plural: "Server URLs";
                  },
              ];
              maxLength: 1000;
              readOnly: true;
          },
      >;
      ssl: Typed<
          boolean,
          {
              default: false;
              label: [
                  {
                      hint: "Use SSL when connecting to this server";
                      label: "SSL";
                      language: "en";
                      plural: "SSLs";
                  },
              ];
          },
      >;
      sys_id: Typed<
          string,
          {
              label: [{ label: "Sys ID"; language: "en"; plural: "Sys IDs" }];
              primary: true;
          },
      >;
      system_id: Typed<string, { label: "System ID"; maxLength: 100 }>;
      vendor: Typed<
          string,
          {
              default: "active_directory";
              dropdown: "dropdown_without_none";
              label: "Vendor";
          },
      >;
  }