Page tree
Skip to end of metadata
Go to start of metadata

Independent project

MidPoint CLI in Python is an independent (third-party) project. The project was independently started by Yannick Kirschhoffer. This project is not maintained by the Evolveum team. However, we find this project very useful and we are very grateful for its existence. It is almost certain that we will help maintaining the project by contributing code if needed.


A command line client to Midpoint Identity Management system. We can find source code on page


Steps below was tested on ubuntu 18.04.

  1. As the first step, we install python3-pip. 

    sudo apt install -y python3-pip
  2. Next, we clone the git project. 

    git clone
  3. We use pip3 to install package. 

    cd midpoint-cli/midpoint_cli/
    pip3 install midpoint-cli
  4. Finally step is starting package midpoint-cli. 

    python3 midpoint-cli


The following arguments can be used during startup, for example python3 midpoint-cli -U http://localhost:8080/ .

TagDescriptionDefault value
-v, --version

-u, --usernameSet the username to authenticate this session.administrator
-p, --passwordSet the password to authenticate this session.5ecr3t
-U, --urlMidpoint base URL.http://localhost/
commandOptional command to be executed immediately.
argOptional command arguments.

Available commands:

get                  Get an XML definition from the server from an existing OID reference.

put                  Create/Update a server object based on an XML structure.

delete            Delete a server object based on its type and OID.

task                 Manage server tasks.

resource        Manage resources on the server.

org                   Manage organizations.

user                 Manage users.

If you don't know how to use command, you can use help. We can also use help in conjunction with the command, for example help user.

See Also

  • No labels