使用 IdM API

IdM API 输出结构

result

这部分提供命令的结果。它包含有关命令操作的各种详细信息，如传递给命令的选项和参数。

values

这部分表示命令的参数。

messages

这部分显示在执行命令后 ipa 工具提供的各种信息。

summary

这部分显示操作的总结。

IdM API 上下文

server

插件集合，其验证传递给 IdM API 命令执行的参数和选项。

client

插件集合，其验证转发给 IdM 服务器执行的参数和选项。

installer

特定于安装过程的插件集合。

updates

特定于更新过程的插件集合。

使用 IdM API 命令管理 IdM 用户的示例

创建 IdM 用户

在本例中，您可以使用用户名 exampleuser 和支持的用户 一次性密码(OTP) 身份验证创建一个 IdM 用户。

api.Command.user_add("exampleuser", givenname="Example", sn="User", ipauserauthtype="otp")

Copy to Clipboard Toggle word wrap

显示 IdM 用户信息

在本例中，您显示有关 IdM 用户 exampleuser 的所有可用信息。

api.Command.user_show("exampleuser", all=True)

Copy to Clipboard Toggle word wrap

修改 IdM 用户

在本例中，您将更改 IdM 用户 exampleuser 的电子邮件地址。

api.Command.user_mod("exampleuser", mail="exampleuser@example.org")

Copy to Clipboard Toggle word wrap

搜索 IdM 用户

在本例中，您将搜索与 IdM 组 admins 中 exampleuser 匹配的所有 IdM 用户。

api.Command.user_find(criteria="exampleuser", in_group="admins")

Copy to Clipboard Toggle word wrap

删除 IdM 用户

在本例中，您将删除 IdM 用户 exampleuser。

api.Command.user_del("exampleuser")

Copy to Clipboard Toggle word wrap

要在以后恢复用户，请使用 preserve 选项。如果使用这个选项，您可以使用 user_undel 命令恢复用户。

为 IdM 用户添加和删除证书

您可以使用 user_add_cert 和 user_remove_cert 命令为用户添加或删除 Base64 编码的 证书。在本例中，您为用户 exampleuser 添加了一个证书。

args = ["exampleuser"]
kw = {
    "usercertificate": """
      MIICYzCCAcygAwIBAgIBADANBgkqhkiG9w0BAQUFADAuMQswCQYDVQQGEwJVUzEMMAoGA1UEC
      hMDSUJNMREwDwYDVQQLEwhMb2NhbCBDQTAeFw05OTEyMjIwNTAwMDBaFw0wMDEyMjMwNDU5NT
      laMC4xCzAJBgNVBAYTAlVTMQwwCgYDVQQKEwNJQk0xETAPBgNVBAsTCExvY2FsIENBMIGfMA0
      GCSqGSIb3DQEBATOPA4GNADCBiQKBgQD2bZEo7xGaX2/0GHkrNFZvlxBou9v1Jmt/PDiTMPve
      8r9FeJAQ0QdvFST/0JPQYD20rH0bimdDLgNdNynmyRoS2S/IInfpmf69iyc2G0TPyRvmHIiOZ
      bdCd+YBHQi1adkj17NDcWj6S14tVurFX73zx0sNoMS79q3tuXKrDsxeuwIDAQABo4GQMIGNME
      sGCVUdDwGG+EIBDQQ+EzxHZW5lcmF0ZWQgYnkgdGhlIFNlY3VyZVdheSBTZWN1cml0eSBTZXJ
      2ZXIgZm9yIE9TLzM5MCAoUkFDRikwDgYDVR0PAQH/BAQDAgAGMA8GA1UdEwEB/wQFMAMBAf8w
      HQYDVR0OBBYEFJ3+ocRyCTJw067dLSwr/nalx6YMMA0GCSqGSIb3DQEBBQUAA4GBAMaQzt+za
      j1GU77yzlr8iiMBXgdQrwsZZWJo5exnAucJAEYQZmOfyLiMD6oYq+ZnfvM0n8G/Y79q8nhwvu
      xpYOnRSAXFp6xSkrIOeZtJMY1h00LKp/JX3Ng1svZ2agE126JHsQ0bhzN5TKsYfbwfTwfjdWA
      Gy6Vf1nYi/rO+ryMO
    """
}

api.Command.user_add_cert(*args, **kw)

Copy to Clipboard Toggle word wrap

启用和禁用 IdM 用户

您可以使用 user_enable 和 user_disable 命令启用或禁用 IdM 用户。在本例中，您禁用了 IdM 用户 exampleuser。

api.Command.user_disable("exampleuser")

Copy to Clipboard Toggle word wrap

使用 IdM API 命令管理 IdM 用户的示例

创建 IdM 组

在本例中，您可以创建一个具有指定组 ID 号 的 IdM 组 developers。

api.Command.group_add("developers", gidnumber=500, description="Developers")

Copy to Clipboard Toggle word wrap

将用户作为成员添加到 IdM 组

在本例中，您将 admin 用户添加到 developers 组。

api.Command.group_add_member("developers", user="admin")

Copy to Clipboard Toggle word wrap

将服务作为成员添加到 IdM 组

在本例中，您要将 HTTP/server.ipa.test 服务添加到 developers 组。

api.Command.group_add_member("developers", service="HTTP/server.ipa.test")

Copy to Clipboard Toggle word wrap

将组作为子组添加到 IdM 组

在本例中，您将另一个组 admins 添加到 developers 组。

api.Command.group_add_member("developers", group="admins")

Copy to Clipboard Toggle word wrap

添加 IdM 组管理者

在这个示例中，您将 bob 用户添加为 developers 组的组管理者。

api.Command.group_add_member_manager("developers", user="bob")

Copy to Clipboard Toggle word wrap

查找 IdM 组

您可以使用各种参数搜索 IdM 组。在这个示例中，您查找到用户 bob 管理的所有组。

api.Command.group_find(membermanager_user="bob")

Copy to Clipboard Toggle word wrap

显示 IdM 组信息

在本例中，您显示有关 developers 组的组信息，而不显示成员列表。

api.Command.group_show("developers", no_members=True)

Copy to Clipboard Toggle word wrap

修改 IdM 组

在本例中，您将非 POSIX 组 testgroup 转换为 POSIX 组。

api.Command.group_mod("testgroup", posix=True)

Copy to Clipboard Toggle word wrap

从 IdM 组中删除成员

在本例中，您从 developers 组中删除 admin 用户。

api.Command.group_remove_member("developers", user="admin")

Copy to Clipboard Toggle word wrap

删除 IdM 组管理者

在这个示例中，您将用户 bob 作为管理器者从 developers 组中删除。

api.Command.group_remove_member_manager("developers", user="bob")

Copy to Clipboard Toggle word wrap

删除 IdM 组

在本例中，您删除 developers 组。

api.Command.group_del("developers")

Copy to Clipboard Toggle word wrap

使用 IdM API 命令管理访问控制的示例

添加创建用户的权限

在本例中，添加创建用户的权限。

api.Command.permission_add("Create users", ipapermright='add', type='user')

Copy to Clipboard Toggle word wrap

添加管理组成员资格的权限

在本例中，您添加将用户添加到组的权限。

api.Command.permission_add("Manage group membership", ipapermright='write', type='group', attrs="member")

Copy to Clipboard Toggle word wrap

为用户创建进程添加特权

在本例中，您添加了创建用户的特权，将它们添加到组，以并管理用户证书。

api.Command.permission_add("Create users", ipapermright='add', type='user')
api.Command.permission_add("Manage group membership", ipapermright='write', type='group', attrs="member")
api.Command.permission_add("Manage User certificates", ipapermright='write', type='user', attrs='usercertificate')

api.Command.privilege_add("User creation")
api.Command.privilege_add_permission("User creation", permission="Create users")
api.Command.privilege_add_permission("User creation", permission="Manage group membership")
api.Command.privilege_add_permission("User creation", permission="Manage User certificates")

Copy to Clipboard Toggle word wrap

使用特权添加角色

在本例中，您要使用上例中创建的特权添加角色。

api.Command.role_add("usermanager", description="Users manager")
api.Command.role_add_privilege("usermanager", privilege="User creation")

Copy to Clipboard Toggle word wrap

向用户分配角色

在本例中，您将 usermanager 角色分配给用户 bob。

api.Command.role_add_member("usermanager", user="bob")

Copy to Clipboard Toggle word wrap

向组分配角色

在本例中，您将 usermanager 角色分配给 managers 组。

api.Command.role_add_member("usermanager", group="managers")

Copy to Clipboard Toggle word wrap

使用 IdM API 命令管理 sudo 规则的示例

创建 sudo 规则

在本例中，您可以创建一个保持时间更改命令的 sudo 规则。

api.Command.sudorule_add("timechange")

Copy to Clipboard Toggle word wrap

创建 sudo 命令

在本例中，您创建 date sudo 命令。

api.Command.sudocmd_add("/usr/bin/date")

Copy to Clipboard Toggle word wrap

将 sudo 命令附加到 sudo 规则

在本例中，您要将 date sudo 命令附加到 timechange sudo 规则。

api.Command.sudorule_add_allow_command("timechange", sudocmd="/usr/bin/date")

Copy to Clipboard Toggle word wrap

创建并附加 sudo 命令组

在本例中，您创建多个 sudo 命令，将它们添加到新创建的 timecmds sudo 命令组中，并将组附加到 timechange sudo 规则。

api.Command.sudocmd_add("/usr/bin/date")
api.Command.sudocmd_add("/usr/bin/timedatectl")
api.Command.sudocmd_add("/usr/sbin/hwclock")
api.Command.sudocmdgroup_add("timecmds")
api.Command.sudocmdgroup_add_member("timecmds", sudocmd="/usr/bin/date")
api.Command.sudocmdgroup_add_member("timecmds", sudocmd="/usr/bin/timedatectl")
api.Command.sudocmdgroup_add_member("timecmds", sudocmd="/usr/sbin/hwclock")
api.Command.sudorule_add_allow_command("timechange", sudocmdgroup="timecmds")

Copy to Clipboard Toggle word wrap

拒绝 sudo 命令

在本例中，您拒绝要作为 sudo 运行的 rm 命令。

api.Command.sudocmd_add("/usr/bin/rm")
api.Command.sudorule_add_deny_command("timechange", sudocmd="/usr/bin/rm")

Copy to Clipboard Toggle word wrap

将用户添加到 sudo 规则

在这个示例中，您将用户 bob 添加到 timechange sudo 规则中。

api.Command.sudorule_add_user("timechange", user="bob")

Copy to Clipboard Toggle word wrap

使 sudo 规则仅对指定的主机可用

在本例中，您将 timechange 规则限制为仅对 client.ipa.test 主机可用。

api.Command.sudorule_add_host("timechange", host="client.ipa.test")

Copy to Clipboard Toggle word wrap

将 sudo 规则设置为以不同用户身份运行

默认情况下，sudo 规则以 root 用户身份运行。在本例中，您将 timechange sudo 规则设置为以 alice 用户身份运行。

api.Command.sudorule_add_runasuser("timechange", user="alice")

Copy to Clipboard Toggle word wrap

将 sudo 规则设置为以组身份运行

在本例中，您将 timechange sudo 规则设置为以 sysadmins 组身份运行。

api.Command.sudorule_add_runasgroup("timechange", group="sysadmins")

Copy to Clipboard Toggle word wrap

为 sudo 规则设置 sudo 选项

在本例中，您为 timechange sudo 规则设置 sudo 选项。

api.Command.sudorule_add_option("timechange", ipasudoopt="logfile='/var/log/timechange_log'")

Copy to Clipboard Toggle word wrap

启用 sudo 规则

在本例中，您启用 timechange sudo 规则。

api.Command.sudorule_enable("timechange")

Copy to Clipboard Toggle word wrap

禁用 sudo 规则

在本例中，您禁用 timechange sudo 规则。

api.Command.sudorule_disable("timechange")

Copy to Clipboard Toggle word wrap

使用 IdM API 命令管理 HBAC 的示例

创建 HBAC 规则

在本例中，您创建一个将处理 SSH 服务访问的基本规则。

api.Command.hbacrule_add("sshd_rule")

Copy to Clipboard Toggle word wrap

将用户添加到 HBAC 规则中

在本例中，您将用户 john 添加到 sshd_rule HBAC 规则中。

api.Command.hbacrule_add_user("sshd_rule", user="john")

Copy to Clipboard Toggle word wrap

将组添加到 HBAC 规则中

在本例中，您将组 developers 添加到 sshd_rule HBAC 规则中。

api.Command.hbacrule_add_user("sshd_rule", group="developers")

Copy to Clipboard Toggle word wrap

从 HBAC 规则中删除用户

在本例中，您从 sshd_rule HBAC 规则中删除用户 john。

api.Command.hbacrule_remove_user("sshd_rule", user="john")

Copy to Clipboard Toggle word wrap

注册新的目标 HBAC 服务

在将其附加到 HBAC 规则前，您必须注册一个目标服务。在本例中，您注册 chronyd 服务。

api.Command.hbacsvc_add("chronyd")

Copy to Clipboard Toggle word wrap

将注册的服务附加到 HBAC 规则中

在本例中，您将 sshd 服务附加到 sshd_rule HBAC 规则中。默认情况下，该服务在 IPA 中注册，因此无需事先使用 hbacsvc_add 进行注册。

api.Command.hbacrule_add_service("sshd_rule", hbacsvc="sshd")

Copy to Clipboard Toggle word wrap

将主机添加到 HBAC 规则中

在本例中，您要 workstations 主机组添加到 sshd_rule HBAC 规则中。

api.Command.hbacrule_add_host("sshd_rule", hostgroup="workstations")

Copy to Clipboard Toggle word wrap

测试 HBAC 规则

在本例中，您对 workstation.ipa.test 主机使用 sshd_rule HBAC 规则。它以来自用户 john 的服务 sshd 为目标。

api.Command.hbactest(user="john", targethost="workstation.ipa.test", service="sshd", rules="sshd_rule")

Copy to Clipboard Toggle word wrap

启用 HBAC 规则

在本例中，您启用 sshd_rule HBAC 规则。

api.Command.hbacrule_enable("sshd_rule")

Copy to Clipboard Toggle word wrap

禁用 HBAC 规则

在本例中，您禁用 sshd_rule HBAC 规则。

api.Command.hbacrule_disable("sshd_rule")

Copy to Clipboard Toggle word wrap