kanidm/kanidm_book/src/client_tools.md

42 lines
1.1 KiB
Markdown
Raw Normal View History

# Client tools
To interact with Kanidm as an administrator, you'll need to use our command line tools. If you haven't installed them yet, [install them now](installing_client_tools.mdc).
## Kanidm configuration
2021-05-26 08:11:00 +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
To authenticate as a user for use with the command line, you need to use the `login` command
to establish a session token.
kanidm login --name USERNAME
kanidm login --name admin
Once complete, you can use `kanidm` without reauthenticating for a period of time for administration.
2021-05-26 08:11:00 +02:00
You can list active sessions with:
2021-05-26 08:11:00 +02:00
kanidm session list
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:
2021-05-26 08:11:00 +02:00
kanidm session cleanup
2021-05-26 08:11:00 +02:00
To logout of a session:
kanidm logout --name USERNAME
kanidm logout --name admin