Browse Source

[Web] Add default_template parameter to edit/identity-provider documentation

FreddleSpl0it 5 months ago
parent
commit
94d4817ecb
1 changed files with 15 additions and 10 deletions
  1. 15 10
      data/web/api/openapi.yaml

+ 15 - 10
data/web/api/openapi.yaml

@@ -5847,12 +5847,11 @@ paths:
                           client_secret: "*"
                           client_secret: "*"
                           redirect_url: "https://mail.mailcow.tld"
                           redirect_url: "https://mail.mailcow.tld"
                           version: "26.1.3"
                           version: "26.1.3"
+                          default_template: "Default"
                           mappers:
                           mappers:
-                            - "Default"
                             - "small_mbox"
                             - "small_mbox"
                             - "medium_mbox"
                             - "medium_mbox"
                           templates:
                           templates:
-                            - "Default"
                             - "small"
                             - "small"
                             - "medium"
                             - "medium"
                           ignore_ssl_error: true
                           ignore_ssl_error: true
@@ -5903,11 +5902,14 @@ paths:
                     version:
                     version:
                       description: Specifies the Keycloak version. Required if `authsource` is keycloak.
                       description: Specifies the Keycloak version. Required if `authsource` is keycloak.
                       type: string
                       type: string
+                    default_template:
+                      description: (Optional) If no matching Attribute Mapping exists for a User, the default template will be used for creating the mailbox, but not for updating the mailbox.
+                      type: string
                     mappers:
                     mappers:
-                      description: Attribute values used to match a mailbox template. Each element corresponds to the respective index in the templates array (i.e., the first element matches the first element of templates, the second matches the second, and so on).
+                      description: (Optional) Attribute values used to match a mailbox template. Each element corresponds to the respective index in the templates array (i.e., the first element matches the first element of templates, the second matches the second, and so on).
                       type: array
                       type: array
                     templates:
                     templates:
-                      description: Defines the mailbox templates to be assigned. Each element corresponds to the respective index in the `mappers` array.
+                      description: (Optional) Defines the mailbox templates to be assigned. Each element corresponds to the respective index in the `mappers` array.
                       type: array
                       type: array
                     ignore_ssl_error:
                     ignore_ssl_error:
                       description: If enabled, SSL certificate validation is bypassed
                       description: If enabled, SSL certificate validation is bypassed
@@ -5988,8 +5990,9 @@ paths:
                     client_secret: "Xy7GdPqvJ9m3R8sT2LkVZ5W1oNbCaYQf"
                     client_secret: "Xy7GdPqvJ9m3R8sT2LkVZ5W1oNbCaYQf"
                     redirect_url: "https://mail.mailcow.tld"
                     redirect_url: "https://mail.mailcow.tld"
                     version: "26.1.3"
                     version: "26.1.3"
-                    mappers: ["Default", "small_mbox", "medium_mbox"]
-                    templates: ["Default", "small", "medium"]
+                    default_template: "Default"
+                    mappers: ["small_mbox", "medium_mbox"]
+                    templates: ["small", "medium"]
                     ignore_ssl_error: true
                     ignore_ssl_error: true
                     mailpassword_flow: true
                     mailpassword_flow: true
                     periodic_sync: true
                     periodic_sync: true
@@ -6012,8 +6015,9 @@ paths:
                     attribute_field: "othermailbox"
                     attribute_field: "othermailbox"
                     binddn: "CN=LDAP Read Only,CN=Users,DC=mailcow,DC=local"
                     binddn: "CN=LDAP Read Only,CN=Users,DC=mailcow,DC=local"
                     bindpass: "moohoo"
                     bindpass: "moohoo"
-                    mappers: ["Default", "small_mbox", "medium_mbox"]
-                    templates: ["Default", "small", "medium"]
+                    default_template: "Default"
+                    mappers: ["small_mbox", "medium_mbox"]
+                    templates: ["small", "medium"]
                     periodic_sync: true
                     periodic_sync: true
                     import_users: true
                     import_users: true
                     sync_interval: 30
                     sync_interval: 30
@@ -6030,8 +6034,9 @@ paths:
                     client_secret: "Xy7GdPqvJ9m3R8sT2LkVZ5W1oNbCaYQf"
                     client_secret: "Xy7GdPqvJ9m3R8sT2LkVZ5W1oNbCaYQf"
                     redirect_url: "https://mail.mailcow.tld"
                     redirect_url: "https://mail.mailcow.tld"
                     client_scopes: "openid profile email mailcow_template"
                     client_scopes: "openid profile email mailcow_template"
-                    mappers: ["Default", "small_mbox", "medium_mbox"]
-                    templates: ["Default", "small", "medium"]
+                    default_template: "Default"
+                    mappers: ["small_mbox", "medium_mbox"]
+                    templates: ["small", "medium"]
                     ignore_ssl_error: true
                     ignore_ssl_error: true
       summary: Edit external Identity Provider
       summary: Edit external Identity Provider