文档

mc idp openid

RELEASE.2023-05-26T23-31-54Z 版本新增: mc idp openid 及其子命令替换 mc admin idp openid

描述

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

定义配置设置作为使用环境变量的替代方法,在 设置 OpenID 连接 时。The mc idp openid 命令仅支持针对 MinIO 部署。

注意

MinIO OpenID 环境变量 覆盖其对应的配置设置,这些设置可以通过此命令修改或设置。

The 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 声明的提供程序。所有其他提供程序必须是基于角色的提供程序。

以下示例为 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://127.0.0.1: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 部署的 别名

  • 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 部署的 别名

  • 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 部署的 别名

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

ls, list

输出 OpenID 提供程序的现有配置集列表。

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

mc idp openid ls myminio

该命令具有以下语法

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

info

输出为 OpenID 提供程序定义的现有服务器配置集的值集。

以下示例输出在 myminio 部署上的 test_config OpenID 设置集中定义的配置设置。

mc idp openid info myminio test_config

该命令具有以下语法

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

  • 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 部署的 别名

  • 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 部署的 别名

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

全局标志

该命令支持任何 全局标志