mc admin idp ldap

Description

The mc admin idp ldap commands allow you to add, modify, review, list, remove, enable, and disable server configurations to 3rd party Active Directory or LDAP Identity and Access Management (IAM) integrations.

Define configuration settings as an alternative to using environment variables when setting up an AD/LDAP connection.

The mc admin idp ldap command has the following subcommands:

Configuration Parameters

The mc admin idp ldap subcommands support configuration parameters. The parameters define the server’s interaction with the Active Directory or LDAP IAM provider.

For a more detailed explanation of the configuration parameters, refer to the config setting documentation.

Syntax

add

Create a new set of configurations for an AD/LDAP provider.

You can run the command multiple times to set up multiple Active Directory or LDAP providers.

EXAMPLE

The following example creates the configuration settings for the myminio deployment as defined in a new test-config setup for LDAP integration.

 mc admin idp ldap add                                               \
      myminio                                                        \
      test-config                                                    \
      server_addr=myldapserver:636                                   \
      lookup_bind_dn=cn=admin,dc=min,dc=io                           \
      lookup_bind_password=somesecret                                \
      user_dn_search_base_dn=dc=min,dc=io                            \
      user_dn_search_filter="(uid=%s)"                               \
      group_search_base_dn=ou=swengg,dc=min,dc=io                    \
      group_search_filter="(&(objectclass=groupofnames)(member=%d))"

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin idp ldap add          \
                           ALIAS             \
                           [CFG_NAME]        \
                           [CFG_PARAM1]      \
                           [CFG_PARAM2]...

• Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

• Replace CFG_NAME with a unique string for this configuration. If not specified, the command creates default configuration values.

• Replace the [CFG_PARAM#] with each of the configuration setting key-value pairs in the format of PARAMETER="value".

update

Modify an existing set of configurations for an AD/LDAP provider.

EXAMPLE

The following example changes two of the configuration settings for the myminio deployment as defined in the test-config setup for LDAP integration.

mc admin idp ldap update                                \
                  myminio                               \
                  test_config                           \
                  lookup_bind_dn=cn=admin,dc=min,dc=io  \
                  lookup_bind_password=somesecret

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin idp ldap update           \
                                ALIAS            \
                                [CFG_NAME]       \
                                [CFG_PARAM1]     \
                                [CFG_PARAM2]...

• Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

• Replace CFG_NAME with a unique string for this configuration. If not specified, the command updates the default configuration.

• Replace the [CFG_PARAM#] with each of the configuration setting key-value pairs to update in the format of PARAMETER="value".

remove

Remove an existing set of configurations for an AD/LDAP provider.

EXAMPLE

The following example removes the test-config settings for the myminio deployment.

mc admin idp ldap remove myminio test_config

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin idp ldap remove     \
                                ALIAS      \
                                [CFG_NAME]

• Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

• Replace CFG_NAME with a unique string for this configuration. If not specified, the command removes the default configurations.

list

Outputs a list of existing configuration sets for AD/LDAP providers.

EXAMPLE

The following example outputs a list of all AD/LDAP configuration sets defined for the myminio deployment.

mc admin idp ldap list myminio

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin idp ldap list ALIAS

• Replace ALIAS with the alias of a MinIO deployment to list AD/LDAP integration for.

info

Outputs the set of values defined for an existing set of server configurations for an AD/LDAP provider.

EXAMPLE

The following example outputs the configuration settings defined for the test_config set of AD/LDAP settings on the myminio deployment.

mc admin idp ldap info myminio test_config

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin idp ldap info     \
                                ALIAS      \
                                [CFG_NAME]

• Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

• Replace CFG_NAME with a unique string for this configuration. If not specified, the information displays for the default server configuration.

enable

Begin using an existing set of configurations for an AD/LDAP provider.

EXAMPLE

The following example enables the server configurations defined as test_config on the myminio deployment.

mc admin idp ldap enable       \
                  myminio      \
                  test_config

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin idp ldap enable     \
                                ALIAS      \
                                [CFG_NAME]

• Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

• Replace CFG_NAME with a unique string for this configuration. If not specified, the command enables the default configuration values.

disable

Stop using a set of configurations for an AD/LDAP provider.

EXAMPLE

The following example disables the server configurations defined as test_config on the myminio deployment.

mc admin idp ldap disable      \
                  myminio      \
                  test_config

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] admin idp ldap disable       \
                                ALIAS         \
                                [CFG_NAME]

• Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

• Replace CFG_NAME with a unique string for this configuration. If not specified, the command disables the default configuration values.

Global Flags

This command supports any of the global flags.