2.3. IdM API コマンドの出力構造
各 IdM API コマンドの出力には、4 つのセクションがあります。これらのセクションには、コマンドの実行に関するさまざまな情報が含まれています。
IdM API の出力構造
result
- このセクションには、コマンドの結果が示されます。これには、コマンドに渡されたオプションや引数など、コマンド操作に関するさまざまな詳細が含まれます。
values
- このセクションには、コマンドの引数が示されます。
messages
-
このセクションには、コマンド実行後に
ipa
ツールが提供するさまざまな情報が示されます。 summary
- このセクションには、操作の概要が示されます。
この例では、スクリプトは add_user
コマンドを実行します。
api.Command.user_add("test", givenname="a", sn="b")
このコマンドの出力構造は次のとおりです。
{ "result": { "displayname": ["a b"], "objectclass": [ "top", "person", "organizationalperson", "inetorgperson", "inetuser", "posixaccount", "krbprincipalaux", "krbticketpolicyaux", "ipaobject", "ipasshuser", "ipaSshGroupOfPubKeys", "mepOriginEntry", "ipantuserattrs", ], "cn": ["a b"], "gidnumber": ["1445000004"], "mail": ["test@ipa.test"], "krbprincipalname": [ipapython.kerberos.Principal("test@IPA.TEST")], "loginshell": ["/bin/sh"], "initials": ["ab"], "uid": ["test"], "uidnumber": ["1445000004"], "sn": ["b"], "krbcanonicalname": [ipapython.kerberos.Principal("test@IPA.TEST")], "homedirectory": ["/home/test"], "givenname": ["a"], "gecos": ["a b"], "ipauniqueid": ["9f9c1df8-5073-11ed-9a56-fa163ea98bb3"], "mepmanagedentry": [ ipapython.dn.DN("cn=test,cn=groups,cn=accounts,dc=ipa,dc=test") ], "has_password": False, "has_keytab": False, "memberof_group": ["ipausers"], "dn": ipapython.dn.DN("uid=test,cn=users,cn=accounts,dc=ipa,dc=test"), }, "value": "test", "messages": [ { "type": "warning", "name": "VersionMissing", "message": "API Version number was not sent, forward compatibility not guaranteed. Assuming server's API version, 2.248", "code": 13001, "data": {"server_version": "2.248"}, } ], "summary": 'Added user "test"', }