action dracoon_update_ad_config {
  label: "Update Active Directory configuration"
  description: "### Description:  \nUpdate an existing Active Directory configuration.\n\n### Precondition:\nRight <span style='padding: 3px; background-color: #F6F7F8; border: 1px solid #000; border-radius: 5px; display: inline;'>&#128275; change global config</span> of the Provider Customer required.\n\n### Postcondition:\nActive Directory configuration updated.\n\n### Further Information:\nNone."
  provider: dracoon
  method: PUT
  path: "/v4/system/config/auth/ads/{ad_id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      "X-Sds-Auth-Token": {
        type: "string"
      }
      adExportGroup: {
        type: "string"
        description: "If `userImport` is set to `true`,\n\nthe user must be member of this Active Directory group to receive a newly created DRACOON account."
      }
      ad_id: {
        type: "integer"
        format: "int32"
      }
      alias: {
        type: "string"
        description: "Unique name for an Active Directory configuration"
      }
      createHomeFolder: {
        type: "boolean"
        description: "DEPRECATED, will be ignored\n\nDetermines whether a room is created for each user that is created by automatic import (like a home folder).\n\nRoom's name will equal the user's login name."
      }
      homeFolderParent: {
        type: "integer"
        format: "int64"
        description: "DEPRECATED, will be ignored\n\nID of the room in which the individual rooms for users will be created."
      }
      ldapUsersDomain: {
        type: "string"
        description: "Search scope of Active Directory; only users below this node can log on."
      }
      sdsImportGroup: {
        type: "integer"
        format: "int64"
        description: "User group that is assigned to users who are created by automatic import.\n\nReset with `0`"
      }
      serverAdminName: {
        type: "string"
        description: "Distinguished Name (DN) of Active Directory administrative account"
      }
      serverAdminPassword: {
        type: "string"
        description: "Password of Active Directory administrative account"
      }
      serverIp: {
        type: "string"
        description: "IPv4 or IPv6 address or host name"
      }
      serverPort: {
        type: "integer"
        format: "int32"
        description: "Port"
      }
      sslFingerPrint: {
        type: "string"
        description: "SSL finger print of Active Directory server.\n\nMandatory for LDAPS connections.\n\nFormat: `Algorithm/Fingerprint`"
      }
      useLdaps: {
        type: "boolean"
        description: "Determines whether LDAPS should be used instead of plain LDAP."
      }
      userFilter: {
        type: "string"
        description: "Name of Active Directory attribute that is used as login name."
      }
      userImport: {
        type: "boolean"
        description: "Determines if a DRACOON account is automatically created for a new user\n\nwho successfully logs on with his / her AD / IDP account."
      }
    }
    required: ["ad_id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "Active Directory configuration"
    required: ["adExportGroup", "alias", "id", "ldapUsersDomain", "serverAdminName", "serverIp", "serverPort", "useLdaps", "userFilter", "userImport"]
    properties: {
      adExportGroup: {
        type: "string"
        description: "If `userImport` is set to `true`,\n\nthe user must be member of this Active Directory group to receive a newly created DRACOON account."
      }
      alias: {
        type: "string"
        description: "Unique name for an Active Directory configuration"
      }
      createHomeFolder: {
        type: "boolean"
        description: "&#128679; Deprecated since v4.10.0\n\nDEPRECATED, will be ignored\n\nDetermines whether a room is created for each user that is created by automatic import (like a home folder).\n\nRoom's name will equal the user's login name."
      }
      homeFolderParent: {
        type: "integer"
        format: "int64"
        description: "&#128679; Deprecated since v4.10.0\n\nDEPRECATED, will be ignored\n\nID of the room in which the individual rooms for users will be created."
      }
      id: {
        type: "integer"
        format: "int32"
        description: "ID"
      }
      ldapUsersDomain: {
        type: "string"
        description: "Search scope of Active Directory; only users below this node can log on."
      }
      sdsImportGroup: {
        type: "integer"
        format: "int64"
        description: "User group that is assigned to users who are created by automatic import.\n\nReset with `0`"
      }
      serverAdminName: {
        type: "string"
        description: "Distinguished Name (DN) of Active Directory administrative account"
      }
      serverIp: {
        type: "string"
        description: "IPv4 or IPv6 address or host name"
      }
      serverPort: {
        type: "integer"
        format: "int32"
        description: "Port"
      }
      sslFingerPrint: {
        type: "string"
        description: "SSL finger print of Active Directory server.\n\nMandatory for LDAPS connections.\n\nFormat: `Algorithm/Fingerprint`"
      }
      useLdaps: {
        type: "boolean"
        description: "Determines whether LDAPS should be used instead of plain LDAP."
      }
      userFilter: {
        type: "string"
        description: "Name of Active Directory attribute that is used as login name."
      }
      userImport: {
        type: "boolean"
        description: "Determines if a DRACOON account is automatically created for a new user\n\nwho successfully logs on with his / her AD / IDP account."
      }
    }
  }
}