文档

mc idp openid

New in version RELEASE.2023-05-26T23-31-54Z: mc idp openid 及其子命令取代 mc admin idp openid

描述

mc idp openid 命令允许你管理第三方 OpenID 身份与访问管理(IAM)集成 的配置。

设置 OpenID 连接 时,可通过定义配置项作为使用环境变量的替代方式。mc idp openid 命令仅支持 MinIO 部署。

Note

MinIO OpenID 环境变量 会覆盖通过此命令修改或设置的对应配置项。

mc idp openid 命令包含以下子命令:

子命令

说明

mc idp openid add

创建 OpenID IDP 服务器配置。

mc idp openid update

修改现有 OpenID IDP 服务器配置。

mc idp openid rm

从部署中移除 OpenID IDP 服务器配置。

mc idp openid ls

输出部署中现有 OpenID 服务器配置列表。

mc idp openid info

显示指定 OpenID 服务器配置的详细信息。

mc idp openid enable

启用 OpenID 服务器配置。

mc idp openid disable

禁用 OpenID 服务器配置。

配置参数

mc idp openid 子命令支持配置参数。 这些参数定义服务器与 IAM 提供方的交互方式。

有关配置参数的更详细说明,请参阅 配置项文档

语法

add

为 OpenID 提供方创建一组新的配置。

你可以多次运行该命令,以设置多个 OpenID 提供方。

添加多个 OpenID 提供方时,只能有一个是基于 JWT Claim 的提供方。 其余都必须是基于角色的提供方。

以下示例为 myminio 部署创建配置项,定义一个新的 test-config 用于 Dex 集成。

 mc idp openid add myminio test-config                                        \
    client_id=minio-client-app                                                \
    client_secret=minio-client-app-secret                                     \
    config_url="http://localhost:5556/dex/.well-known/openid-configuration"   \
    scopes="openid,groups"                                                    \
    redirect_uri="http://127.0.0.1:10000/oauth_callback"                      \
    role_policy="consoleAdmin"

命令语法如下:

mc [GLOBALFLAGS] idp openid add               \
                            ALIAS             \
                            [CFG_NAME]        \
                            [CFG_PARAM1]      \
                            [CFG_PARAM2]...
  • ALIAS 替换为要配置 OpenID 集成的 MinIO 部署 alias

  • CFG_NAME 替换为此配置的唯一字符串。 如果未指定,命令将创建默认配置值。

  • [CFG_PARAM#] 替换为各个 配置项 键值对,格式为 PARAMETER="value"

update

修改 OpenID 提供方现有的一组配置。

以下示例修改 myminio 部署中 test-config 的两个配置项,该配置用于 Dex 集成。

mc idp openid update                      \
              myminio                     \
              test_config                 \
              scopes="openid,groups"      \
              role_policy="consoleAdmin"

命令语法如下:

mc [GLOBALFLAGS] idp openid update           \
                            ALIAS            \
                            [CFG_NAME]       \
                            [CFG_PARAM1]     \
                            [CFG_PARAM2]...
  • ALIAS 替换为要配置 OpenID 集成的 MinIO 部署 alias

  • CFG_NAME 替换为此配置的唯一字符串。 如果未指定,命令将更新默认配置。

  • [CFG_PARAM#] 替换为要更新的各个 配置项 键值对,格式为 PARAMETER="value"

rm, remove

移除 OpenID 提供方现有的一组配置。

以下示例移除 myminio 部署中的 test-config 配置。

mc idp openid rm myminio test_config

命令语法如下:

mc [GLOBALFLAGS] idp openid rm          \
                            ALIAS       \
                            [CFG_NAME]
  • ALIAS 替换为要配置 OpenID 集成的 MinIO 部署 alias

  • CFG_NAME 替换为此配置的唯一字符串。 如果未指定,命令将移除默认配置。

ls, list

输出 OpenID 提供方现有配置集列表。

以下示例输出为 myminio 部署定义的全部 OpenID 配置集列表。

mc idp openid ls myminio

命令语法如下:

mc [GLOBALFLAGS] idp openid ls ALIAS
  • ALIAS 替换为要列出 OpenID 集成的 MinIO 部署 alias

info

输出 OpenID 提供方现有服务器配置集中定义的一组值。

以下示例输出 myminio 部署中 test_config 这组 OpenID 设置定义的配置项。

mc idp openid info myminio test_config

命令语法如下:

mc [GLOBALFLAGS] idp openid info        \
                            ALIAS       \
                            [CFG_NAME]
  • ALIAS 替换为要配置 OpenID 集成的 MinIO 部署 alias

  • CFG_NAME 替换为此配置的唯一字符串。 如果未指定,则显示默认服务器配置的信息。

enable

开始使用 OpenID 提供方现有的一组配置。

以下示例启用 myminio 部署中定义为 test_config 的服务器配置。

mc idp openid enable       \
              myminio      \
              test_config

命令语法如下:

mc [GLOBALFLAGS] idp openid enable     \
                            ALIAS      \
                            [CFG_NAME]
  • ALIAS 替换为要配置 OpenID 集成的 MinIO 部署 alias

  • CFG_NAME 替换为此配置的唯一字符串。 如果未指定,命令将启用默认配置值。

disable

停止使用 OpenID 提供方的一组配置。

以下示例禁用 myminio 部署中定义为 test_config 的服务器配置。

mc idp openid disable      \
              myminio      \
              test_config

命令语法如下:

mc [GLOBALFLAGS] idp openid disable       \
                            ALIAS         \
                            [CFG_NAME]
  • ALIAS 替换为要配置 OpenID 集成的 MinIO 部署 alias

  • CFG_NAME 替换为此配置的唯一字符串。 如果未指定,命令将禁用默认配置值。

全局标志

此命令支持 全局标志 中的任意选项。