2021-07-24 03:12:35 +02:00
|
|
|
# Client tools
|
2019-12-03 07:03:05 +01:00
|
|
|
|
2022-06-02 03:09:02 +02:00
|
|
|
To interact with Kanidm as an administrator, you'll need to use our command
|
2022-12-21 00:53:57 +01:00
|
|
|
line tools. If you haven't installed them yet, [install them now](installing_client_tools.md).
|
2019-12-03 07:03:05 +01:00
|
|
|
|
2021-06-25 10:38:45 +02:00
|
|
|
## Kanidm configuration
|
2021-05-26 08:11:00 +02:00
|
|
|
|
2022-05-27 01:07:56 +02:00
|
|
|
You can configure `kanidm` to help make commands simpler by modifying `~/.config/kanidm`
|
|
|
|
or `/etc/kanidm/config`.
|
2021-05-26 08:11:00 +02:00
|
|
|
|
|
|
|
uri = "https://idm.example.com"
|
|
|
|
verify_ca = true|false
|
|
|
|
verify_hostnames = true|false
|
|
|
|
ca_path = "/path/to/ca.pem"
|
|
|
|
|
|
|
|
Once configured, you can test this with:
|
|
|
|
|
|
|
|
kanidm self whoami --name anonymous
|
|
|
|
|
|
|
|
## Session Management
|
2020-09-18 05:19:57 +02:00
|
|
|
|
2022-05-27 01:07:56 +02:00
|
|
|
To authenticate as a user (for use with the command line), you need to use the `login` command
|
2020-09-18 05:19:57 +02:00
|
|
|
to establish a session token.
|
|
|
|
|
|
|
|
kanidm login --name USERNAME
|
|
|
|
kanidm login --name admin
|
|
|
|
|
2022-05-27 01:07:56 +02:00
|
|
|
Once complete, you can use `kanidm` without re-authenticating for a period of time for administration.
|
2020-09-18 05:19:57 +02:00
|
|
|
|
2021-05-26 08:11:00 +02:00
|
|
|
You can list active sessions with:
|
2019-12-03 07:03:05 +01:00
|
|
|
|
2021-05-26 08:11:00 +02:00
|
|
|
kanidm session list
|
2019-12-03 07:03:05 +01:00
|
|
|
|
2021-05-26 08:11:00 +02:00
|
|
|
Sessions will expire after a period of time (by default 1 hour). To remove these expired sessions
|
|
|
|
locally you can use:
|
2019-12-03 07:03:05 +01:00
|
|
|
|
2021-05-26 08:11:00 +02:00
|
|
|
kanidm session cleanup
|
2019-12-03 07:03:05 +01:00
|
|
|
|
2022-05-27 01:07:56 +02:00
|
|
|
To log out of a session:
|
2021-05-26 08:11:00 +02:00
|
|
|
|
|
|
|
kanidm logout --name USERNAME
|
2022-12-21 00:53:57 +01:00
|
|
|
kanidm logout --name admin
|