# mc idp openid

LLMS 索引： [llms.txt](/zh/llms.txt)

---

<a id="mc-idp-openid"></a>
<a id="minio-mc-idp-openid"></a>

<a id="command-mc.idp.openid"></a>

> [!NOTE]
> **新增: RELEASE.2023-05-26T23-31-54Z**
>
> [`mc idp openid`](#command-mc.idp.openid) 及其子命令取代 `mc admin idp openid`。

## 描述 {#id2}

[`mc idp openid`](#command-mc.idp.openid) 命令允许你管理第三方 [OpenID 身份与访问管理（IAM）集成](/zh/administration/identity-access-management/oidc-access-management/#minio-external-identity-management-openid) 的配置。

在 [设置 OpenID 连接](/zh/operations/external-iam/configure-openid-external-identity-management/#minio-external-identity-management-openid-configure) 时，可通过定义配置项作为使用环境变量的替代方式。[`mc idp openid`](#command-mc.idp.openid) 命令仅支持 MinIO 部署。

> [!NOTE]
> **说明**
>
> MinIO [OpenID 环境变量](/zh/reference/minio-server/settings/iam/openid/#minio-server-envvar-external-identity-management-openid) 会覆盖通过此命令修改或设置的对应配置项。

[`mc idp openid`](#command-mc.idp.openid) 命令包含以下子命令：

| 子命令 | 说明 |
| --- | --- |
| [`mc idp openid add`](#mc.idp.openid.add) | 创建 OpenID IDP 服务器配置。 |
| [`mc idp openid update`](#mc.idp.openid.update) | 修改现有 OpenID IDP 服务器配置。 |
| [`mc idp openid rm`](#mc.idp.openid.rm) | 从部署中移除 OpenID IDP 服务器配置。 |
| [`mc idp openid ls`](#mc.idp.openid.ls) | 输出部署中现有 OpenID 服务器配置列表。 |
| [`mc idp openid info`](#mc.idp.openid.info) | 显示指定 OpenID 服务器配置的详细信息。 |
| [`mc idp openid enable`](#mc.idp.openid.enable) | 启用 OpenID 服务器配置。 |
| [`mc idp openid disable`](#mc.idp.openid.disable) | 禁用 OpenID 服务器配置。 |

## 配置参数 {#id3}

[`mc idp openid`](#command-mc.idp.openid) 子命令支持配置参数。 这些参数定义服务器与 IAM 提供方的交互方式。

有关配置参数的更详细说明，请参阅 [配置项文档](/zh/reference/minio-server/settings/iam/openid/#minio-open-id-config-settings)。

## 语法 {#id4}

#### `add` {#mc.idp.openid.add}

*mc-cmd*

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

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

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

**示例**

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

```shell
 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"
```

**语法**

命令语法如下：

```shell
mc [GLOBALFLAGS] idp openid add               \
                            ALIAS             \
                            [CFG_NAME]        \
                            [CFG_PARAM1]      \
                            [CFG_PARAM2]...
```

- 将 `ALIAS` 替换为要配置 OpenID 集成的 MinIO 部署 [alias](/zh/reference/minio-mc/mc-alias-set/#alias)。
- 将 `CFG_NAME` 替换为此配置的唯一字符串。 如果未指定，命令将创建默认配置值。
- 将 `[CFG_PARAM#]` 替换为各个 [配置项](/zh/reference/minio-server/settings/iam/openid/#minio-open-id-config-settings) 键值对，格式为 `PARAMETER="value"`。

#### `update` {#mc.idp.openid.update}

*mc-cmd*

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

**示例**

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

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

**语法**

命令语法如下：

```shell
mc [GLOBALFLAGS] idp openid update           \
                            ALIAS            \
                            [CFG_NAME]       \
                            [CFG_PARAM1]     \
                            [CFG_PARAM2]...
```

- 将 `ALIAS` 替换为要配置 OpenID 集成的 MinIO 部署 [alias](/zh/reference/minio-mc/mc-alias-set/#alias)。
- 将 `CFG_NAME` 替换为此配置的唯一字符串。 如果未指定，命令将更新默认配置。
- 将 `[CFG_PARAM#]` 替换为要更新的各个 [配置项](/zh/reference/minio-server/settings/iam/openid/#minio-open-id-config-settings) 键值对，格式为 `PARAMETER="value"`。

#### `rm, remove` {#mc.idp.openid.rm}

*mc-cmd*

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

**示例**

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

```shell
mc idp openid rm myminio test_config
```

**语法**

命令语法如下：

```shell
mc [GLOBALFLAGS] idp openid rm          \
                            ALIAS       \
                            [CFG_NAME]
```

- 将 `ALIAS` 替换为要配置 OpenID 集成的 MinIO 部署 [alias](/zh/reference/minio-mc/mc-alias-set/#alias)。
- 将 `CFG_NAME` 替换为此配置的唯一字符串。 如果未指定，命令将移除默认配置。

#### `ls, list` {#mc.idp.openid.ls}

*mc-cmd*

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

**示例**

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

```shell
mc idp openid ls myminio
```

**语法**

命令语法如下：

```shell
mc [GLOBALFLAGS] idp openid ls ALIAS
```

- 将 `ALIAS` 替换为要列出 OpenID 集成的 MinIO 部署 [alias](/zh/reference/minio-mc/mc-alias-set/#alias)。

#### `info` {#mc.idp.openid.info}

*mc-cmd*

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

**示例**

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

```shell
mc idp openid info myminio test_config
```

**语法**

命令语法如下：

```shell
mc [GLOBALFLAGS] idp openid info        \
                            ALIAS       \
                            [CFG_NAME]
```

- 将 `ALIAS` 替换为要配置 OpenID 集成的 MinIO 部署 [alias](/zh/reference/minio-mc/mc-alias-set/#alias)。
- 将 `CFG_NAME` 替换为此配置的唯一字符串。 如果未指定，则显示默认服务器配置的信息。

#### `enable` {#mc.idp.openid.enable}

*mc-cmd*

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

**示例**

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

```shell
mc idp openid enable       \
              myminio      \
              test_config
```

**语法**

命令语法如下：

```shell
mc [GLOBALFLAGS] idp openid enable     \
                            ALIAS      \
                            [CFG_NAME]
```

- 将 `ALIAS` 替换为要配置 OpenID 集成的 MinIO 部署 [alias](/zh/reference/minio-mc/mc-alias-set/#alias)。
- 将 `CFG_NAME` 替换为此配置的唯一字符串。 如果未指定，命令将启用默认配置值。

#### `disable` {#mc.idp.openid.disable}

*mc-cmd*

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

**示例**

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

```shell
mc idp openid disable      \
              myminio      \
              test_config
```

**语法**

命令语法如下：

```shell
mc [GLOBALFLAGS] idp openid disable       \
                            ALIAS         \
                            [CFG_NAME]
```

- 将 `ALIAS` 替换为要配置 OpenID 集成的 MinIO 部署 [alias](/zh/reference/minio-mc/mc-alias-set/#alias)。
- 将 `CFG_NAME` 替换为此配置的唯一字符串。 如果未指定，命令将禁用默认配置值。

## 全局标志 {#id5}

此命令支持 [全局标志](/zh/reference/minio-mc/#minio-mc-global-options) 中的任意选项。