#6814 [RFE] API client lib for 3rd party apps
Opened 7 years ago by pvoborni. Modified 6 years ago

User story is:

As an application which integrates with FreeIPA, I want to initialize API and then call api commands. I already know what are the commands names and versions or type and names of theirs parameters and options.

Acceptance criteria:

  • the command should not require any interaction with users
  • if client side preprocessing of arguments which would be otherwise/usually entered and then processed by CLI is needed(e.g. as in vault-archive), then it needs to be done as well
  • It should not download metadata automatically unless asked. Because the app knows what it wants to call.
  • authentication should be done automatically on first command call (assuming Kerberos)
  • if executed command reads or writes data from file cache (e.g. KRA transport cert) then the cache dir needs to be configurable
  • the new API usage is documented with examples

Background:
ipalib was designed and implemented for FreeIPA API, FreeIPA command line utilities which run on server and CLI. All of these usages work with some assumptions . E.g. on server, commands can be introspected and called. On client commands are got from server by downloading metadata. The library can be used in 3rd part apps(integrations) but they need to follow CLI principals or do hacks. This RFE is to support such apps without them doing hacks.


Metadata Update from @pvoborni:
- Issue tagged with: rfe

7 years ago

Metadata Update from @pvoborni:
- Issue tagged with: integration

7 years ago

Metadata Update from @pvoborni:
- Issue priority set to: blocker
- Issue set to the milestone: FreeIPA 4.7
- Issue tagged with: userstory

7 years ago

Metadata Update from @pvoborni:
- Issue priority set to: important (was: critical)
- Issue set to the milestone: FreeIPA 4.8 (was: FreeIPA 4.7)

6 years ago

Log in to comment on this ticket.

Metadata