mirror of
https://github.com/minio/docs.git
synced 2025-07-28 19:42:10 +03:00
9ea539b8ab
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>
114 lines
3.5 KiB
ReStructuredText
114 lines
3.5 KiB
ReStructuredText
.. _minio-mc-idp-ldap-policy-entities:
|
|
|
|
===============================
|
|
``mc idp ldap policy entities``
|
|
===============================
|
|
|
|
.. default-domain:: minio
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
:depth: 2
|
|
|
|
.. mc:: mc idp ldap policy entities
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
.. start-mc-idp-ldap-policy-entities-desc
|
|
|
|
The :mc:`mc idp ldap policy entities` command displays a list of mappings for a user, group, and/or policy.
|
|
|
|
.. end-mc-idp-ldap-policy-entities-desc
|
|
|
|
.. tab-set::
|
|
|
|
.. tab-item:: EXAMPLE
|
|
|
|
The following example lists all mappings for a specific policy, a set of groups, and a selection of users on the ``myminio`` deployment.
|
|
|
|
Specifically, it lists:
|
|
|
|
- Users mapped to the ``finteam-policy`` policy.
|
|
- Policies assigned to the ``uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io`` user.
|
|
- Policies assigned to the ``cn=projectb,ou=groups,ou=swengg,dc=min,dc=io`` group.
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc idp ldap policy entities myminio \
|
|
--policy finteam-policy \
|
|
--user 'uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io' \
|
|
--group 'cn=projectb,ou=groups,ou=swengg,dc=min,dc=io'
|
|
|
|
.. tab-item:: SYNTAX
|
|
|
|
The command has the following syntax:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc [GLOBALFLAGS] idp ldap policy entities \
|
|
ALIAS \
|
|
[--user `value`, -u `value`] \
|
|
[--group `value`, -g `value`] \
|
|
[--policy value]
|
|
|
|
- Replace ``ALIAS`` with the :ref:`alias <alias>` of a MinIO deployment to configure for AD/LDAP integration.
|
|
- You may use each of the ``--user``, ``--group``, and/or ``--policy`` flags as many times as desired in the command.
|
|
- For each flag, the output lists the entities mapped to the specified policy, user, or group.
|
|
- Omit all flags to return a list of mappings for all policies.
|
|
|
|
.. 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 for which to display the entity mappings.
|
|
|
|
For example:
|
|
|
|
.. code-block:: none
|
|
|
|
mc idp ldap policy entities myminio
|
|
|
|
|
|
Example
|
|
~~~~~~~
|
|
|
|
The following example lists the entities mapped to each of two policies, ``policy1`` and ``policy2`` and entities mapped to the ``projectb`` group on the ``myminio`` deployment:
|
|
|
|
.. code-block:: shell
|
|
:class: copyable
|
|
|
|
mc idp ldap policy entities myminio \
|
|
policy1 \
|
|
policy2 \
|
|
--group='cn=projectb,ou=groups,ou=swengg,dc=min,dc=io'
|
|
|
|
|
|
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
|