1
0
mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00
Files
docs/source/reference/minio-mc/mc-idp-ldap-update.rst
Andrea Longo 9ea539b8ab Restructure/expand mc idp ldap reference pages (#959)
Improve the AD/LDAP reference docs:

- Break up `mc idp ldap` and `mc idp ldap policy` into parents/children.
- Add commands from the `identity_ldap` configuration key to `mc idp
ldap add` and `mc idp ldap update`.
- Update links from relevant envvars to `mc idp ldap` instead of
`identity_ldap`
- Fix stuff that needs fixing.

Staged:

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap.html

http://192.241.195.202:9000/staging/DOCS-919-4-idp-ldap/linux/html/reference/minio-mc/mc-idp-ldap-policy.html
Fixes https://github.com/minio/docs/issues/940

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-08-18 13:50:15 -06:00

95 lines
2.4 KiB
ReStructuredText

.. _minio-mc-idp-ldap-update:
======================
``mc idp ldap update``
======================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc idp ldap update
Description
-----------
.. start-mc-idp-ldap-update-desc
The :mc:`mc idp ldap update` command modifies an existing set of configurations for an AD/LDAP provider.
.. end-mc-idp-ldap-update-desc
.. tab-set::
.. tab-item:: EXAMPLE
The following example changes two of the AD/LDAP configuration settings for the ``myminio`` deployment.
.. code-block:: shell
:class: copyable
mc idp ldap update \
myminio \
lookup_bind_dn=cn=admin,dc=min,dc=io \
lookup_bind_password=somesecret
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] idp ldap update \
ALIAS \
[CFG_PARAM1] \
[CFG_PARAM2]...
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment to update for AD/LDAP integration.
- Replace the ``[CFG_PARAM#]`` with each of the :ref:`configuration setting <minio-ldap-config-settings>` key-value pairs in the format of ``PARAMETER="value"``.
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
:required:
The :ref:`alias <alias>` of the MinIO deployment on which to modify an AD/LDAP integration.
For example:
.. code-block:: none
mc idp ldap update myminio \
lookup_bind_dn=cn=admin,dc=min,dc=io \
.. include:: /includes/common-minio-ad-ldap-params.rst
:start-after: start-minio-ad-ldap-params
:end-before: end-minio-ad-ldap-params
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility