2.4. 列出 IdM API 命令和参数
您可以使用 command_show
和 param_show
来列出 IdM API 命令及其参数的信息。
先决条件
- IdM API 已初始化。如需更多信息,请参阅 初始化 IdM API。
流程
要显示
user_add
命令的信息,请执行以下代码:api.Command.command_show("user_add")
这个命令的结果如下:
{ "result": { "name": "user_add", "version": "1", "full_name": "user_add/1", "doc": "Add a new user.", "topic_topic": "user/1", "obj_class": "user/1", "attr_name": "add", }, "value": "user_add", "messages": [ { "type": "warning", "name": "VersionMissing", "message": "API Version number was not sent, forward compatibility not guaranteed. Assuming server's API version, 2.251", "code": 13001, "data": {"server_version": "2.251"}, } ], "summary": None, }
要显示
user_add
命令的givenname
参数的信息,请执行以下代码:api.Command.param_show("user_add", name="givenname")
这个命令的结果如下:
{ "result": { "name": "givenname", "type": "str", "positional": False, "cli_name": "first", "label": "First name", }, "value": "givenname", "messages": [ { "type": "warning", "name": "VersionMissing", "message": "API Version number was not sent, forward compatibility not guaranteed. Assuming server's API version, 2.251", "code": 13001, "data": {"server_version": "2.251"}, } ], "summary": None, }