Chapter 2. Basics of IdM API

Procedure

1. To initialize the IdM API, include the following code in the beginning of your script:

   from ipalib import api
   
   api.bootstrap(context="server")
   api.finalize()

   Copy to Clipboard Toggle word wrap

2. To establish a connection with the LDAP server, add the following logic to your script after API initialization:

   if api.env.in_server:
       api.Backend.ldap2.connect()
   else:
       api.Backend.rpcclient.connect()

   Copy to Clipboard Toggle word wrap
   • If you run your script on the IdM server, this logic allows your script to connect directly to LDAP server.
   • If you run your script on the IdM client, the script uses the Remote Procedure Call (RPC) client.

Procedure

1. To display information about user_add command, execute the following code:

   api.Command.command_show("user_add")

   Copy to Clipboard Toggle word wrap

   The result for this command is as follows:

   {
       "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,
   }

   Copy to Clipboard Toggle word wrap

2. To display information about the givenname parameter for the user_add command, execute the following code:

   api.Command.param_show("user_add", name="givenname")

   Copy to Clipboard Toggle word wrap

   The result for this command is as follows:

   {
       "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,
   }

   Copy to Clipboard Toggle word wrap