sensu.sensu_go.oidc_auth_provider 模块 – 管理 Sensu OIDC 身份验证提供程序

注意

此模块是 sensu.sensu_go 集合 (版本 1.14.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install sensu.sensu_go。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：sensu.sensu_go.oidc_auth_provider。

注意

由于违反了 Ansible 包含要求，sensu.sensu_go 集合将在 Ansible 12 中删除。该集合存在 未解决的完整性测试失败。有关更多信息，请参见 讨论主题。

sensu.sensu_go 1.10.0 中的新增功能

概要

要求

执行此模块的主机需要以下要求。

  • python >= 2.7

参数

参数

注释

additional_scopes

列表 / 元素=字符串

包含在声明中的范围。

默认值： ["openid"]

auth

字典

身份验证参数。也可以使用 ENV 定义每个参数。

api_key

字符串

在 sensu.sensu_go 1.3.0 中添加

身份验证时应使用的 API 密钥。如果未设置此值，则会检查 SENSU_API_KEY 环境变量的值。

此参数替换了 *auth.user* 和 *auth.password* 参数。

有关 API 密钥的更多信息，请参阅 Sensu 官方文档 https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/。

ca_path

路径

在 sensu.sensu_go 1.5.0 中添加

应用于验证后端证书的 CA 证书包的路径。

如果未设置此参数，模块将使用 python 使用的 CA 证书包。

也可以通过 *SENSU_CA_PATH* 环境变量设置此参数。

password

字符串

Sensu 用户的密码。如果未设置此值，则会检查 SENSU_PASSWORD 环境变量的值。

如果设置了 *auth.api_key* 参数，则忽略此参数。

默认值： "P@ssw0rd!"

url

字符串

Sensu 后端 API 的位置。如果未设置此值，则会检查 SENSU_URL 环境变量的值。

默认值： "https://127.0.0.1:8080"

user

字符串

用于连接到 Sensu API 的用户名。如果未设置此值，则会检查 SENSU_USER 环境变量的值。

如果设置了 *auth.api_key* 参数，则忽略此参数。

默认值： "admin"

verify

布尔值

在 sensu.sensu_go 1.5.0 中添加

控制证书验证的标志。

如果您使用的是自签名证书，则可以将此参数设置为 false。

仅在开发场景中使用此参数！如果您在生产环境中使用自签名证书，请参见 *auth.ca_path* 参数。

也可以通过 *SENSU_VERIFY* 环境变量设置此参数。

选项

  • false

  • true ← (默认)

client_id

字符串

OIDC 提供程序应用程序客户端 ID。

如果 *state* 为 present，则需要此参数。

client_secret

字符串

OIDC 提供程序应用程序客户端密钥。

如果 *state* 为 present，则需要此参数。

disable_offline_access

布尔值

如果为 true，则 OIDC 提供程序无法在身份验证请求中包含 offline_access 范围。否则为 false。

选项

  • false ← (默认)

  • true

groups_claim

字符串

用于形成关联的 RBAC 组的声明。

groups_prefix

字符串

添加到所有 OIDC 组的前缀。

name

字符串 / 必需

Sensu 资源的名称。此名称（在适用的情况下与命名空间组合）唯一标识 Ansible 操作的资源。

如果具有所选名称的资源已存在，Ansible 模块会将其更新以匹配任务中的规范。

有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于 https://docs.sensu.io/sensu-go/latest/reference/ 的 *name* 元数据属性规范。

redirect_uri

字符串

要提供给 OIDC 提供程序的重定向 URL。

server

字符串

您希望针对其进行身份验证的 OIDC 服务器的位置。

如果 *state* 为 present，则需要此参数。

state

字符串

Sensu 对象的目标状态。

选项

  • "present" ← (默认)

  • "absent"

username_claim

字符串

用于形成最终 RBAC 用户名的声明。

如果 *state* 为 present，则需要此参数。

username_prefix

字符串

添加到所有 OIDC 用户名的前缀。

备注

注意

  • 仅在 Sensu Go 版本 >= 6 上受支持。

另请参阅

另请参阅

sensu.sensu_go.auth_provider_info

列出 Sensu 身份验证提供程序。

sensu.sensu_go.ldap_auth_provider

管理 Sensu LDAP 身份验证提供程序。

sensu.sensu_go.ad_auth_provider

管理 Sensu AD 身份验证提供程序。

示例

- name: Create a OIDC auth provider
  sensu.sensu_go.oidc_auth_provider:
    state: present
    name: oidc_name
    additional_scopes:
        - groups
        - email
    client_id: a8e43af034e7f2608780
    client_secret: b63968394be6ed2edb61c93847ee792f31bf6216
    disable_offline_access: false
    redirect_uri: http://127.0.0.1:8080/api/enterprise/authentication/v2/oidc/callback
    server: https://oidc.example.com:9031
    groups_claim: groups
    groups_prefix: 'oidc:'
    username_claim: email
    username_prefix: 'oidc:'

- name: Delete a OIDC auth provider
  sensu.sensu_go.oidc_auth_provider:
    name: oidc_name
    state: absent

返回值

常见的返回值已记录在 此处，以下是此模块特有的字段

键

描述

对象

字典

表示 Sensu OIDC 身份验证提供程序的对象。

返回： 成功

示例： {"additional_scopes": ["groups", "email"], "client_id": "a8e43af034e7f2608780", "disable_offline_access": false, "groups_claim": "groups", "groups_prefix": "oidc:", "metadata": {"created_by": "admin", "name": "oidc_name"}, "redirect_uri": "http://sensu-backend.example.com:8080/api/enterprise/authentication/v2/oidc/callback", "server": "https://oidc.example.com:9031", "username_claim": "email", "username_prefix": "oidc:"}

作者

  • Aljaz Kosir (@aljazkosir)

  • Manca Bizjak (@mancabizjak)

  • Miha Dolinar (@mdolin)

  • Tadej Borovsak (@tadeboro)