MEmetabase
/api/ldap

PUT /api/ldap/settings

Changed on

Update LDAP related settings. You must be a superuser to do this.

put/api/ldap/settings

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

ldap-attribute-emailstring nullable
ldap-attribute-firstnamestring nullable
ldap-attribute-lastnamestring nullable
ldap-bind-dnstring nullable
ldap-enabledboolean nullable
ldap-group-basestring nullable
ldap-group-mappingsMetabaseSsoSchemaGroupMappings

An identity provider's groups mapped to the Metabase group IDs that membership in them grants. The keys are the provider's -- LDAP group DNs, SAML and JWT group names -- so the map is string-keyed on its way in; it is stored as a JSON setting and read back through that setting's own decoder.

ldap-group-membership-filterstring nullable
ldap-group-syncboolean nullable
ldap-hoststring nullable
ldap-passwordstring nullable
ldap-portinteger nullable
ldap-security'none' | 'ssl' | 'starttls' nullable
ldap-user-basestring nullable
ldap-user-filterstring nullable

Response

Successful response

Changes

  • 2e178f5a7934Revision changes
    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      added subschema #1 subschema #2 to the request property anyOf list

  • 78297d193ca4Revision changes
    • info

      api operation id put-api-ldap-settings was added