summaryrefslogtreecommitdiffstats
path: root/API.txt
diff options
context:
space:
mode:
authorJan Cholasta <jcholast@redhat.com>2016-06-03 09:38:11 +0200
committerJan Cholasta <jcholast@redhat.com>2016-06-20 16:39:12 +0200
commitdb13494045198842a049d40a3481d9081c7ce175 (patch)
treed43e0f1f595214edc025a5a4ee566fc38b0aee4e /API.txt
parenta95e0777ac64cc8edad152f189be5347117785ef (diff)
downloadfreeipa-db13494045198842a049d40a3481d9081c7ce175.tar.gz
freeipa-db13494045198842a049d40a3481d9081c7ce175.tar.xz
freeipa-db13494045198842a049d40a3481d9081c7ce175.zip
makeaci, makeapi: use in-server API
Capture the server API rather than client API in API.txt. Client API may be affected by client-side plugins and thus may not correspond to what is transmitted over the wire. https://fedorahosted.org/freeipa/ticket/4739 Reviewed-By: David Kupka <dkupka@redhat.com>
Diffstat (limited to 'API.txt')
-rw-r--r--API.txt131
1 files changed, 6 insertions, 125 deletions
diff --git a/API.txt b/API.txt
index eb14d44ee..35ae5e424 100644
--- a/API.txt
+++ b/API.txt
@@ -343,13 +343,6 @@ output: Output('count', type=[<type 'int'>])
output: ListOfEntries('result')
output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: Output('truncated', type=[<type 'bool'>])
-command: automountlocation_import
-args: 2,2,1
-arg: Str('cn', cli_name='location')
-arg: Str('masterfile')
-option: Flag('continue?', autofill=True, cli_name='continue', default=False)
-option: Str('version?')
-output: Output('result')
command: automountlocation_show
args: 1,4,3
arg: Str('cn', cli_name='location')
@@ -761,7 +754,7 @@ option: Str('version?')
output: Output('result')
command: cert_request
args: 1,6,1
-arg: File('csr', cli_name='csr_file')
+arg: Str('csr', cli_name='csr_file')
option: Flag('add', autofill=True, default=False)
option: Str('cacn?', cli_name='ca')
option: Str('principal')
@@ -816,7 +809,7 @@ args: 1,6,3
arg: Str('cn', cli_name='id')
option: Flag('all', autofill=True, cli_name='all', default=False)
option: Str('description', cli_name='desc')
-option: File('file', cli_name='file')
+option: Str('file', cli_name='file')
option: Bool('ipacertprofilestoreissued', cli_name='store', default=True)
option: Flag('raw', autofill=True, cli_name='raw', default=False)
option: Str('version?')
@@ -830,7 +823,7 @@ option: Str('addattr*', cli_name='addattr')
option: Flag('all', autofill=True, cli_name='all', default=False)
option: Str('delattr*', cli_name='delattr')
option: Str('description?', autofill=False, cli_name='desc')
-option: File('file?', cli_name='file')
+option: Str('file?', cli_name='file')
option: Bool('ipacertprofilestoreissued?', autofill=False, cli_name='store', default=True)
option: Flag('raw', autofill=True, cli_name='raw', default=False)
option: Flag('rights', autofill=True, default=False)
@@ -3018,7 +3011,7 @@ arg: Str('ldapuri', cli_name='ldap_uri')
arg: Password('bindpw', cli_name='password', confirm=False)
option: DNParam('basedn?', cli_name='base_dn')
option: DNParam('binddn?', autofill=True, cli_name='bind_dn', default=ipapython.dn.DN('cn=directory manager'))
-option: File('cacertfile?', cli_name='ca_cert_file')
+option: Str('cacertfile?', cli_name='ca_cert_file')
option: Flag('compat?', autofill=True, cli_name='with_compat', default=False)
option: Flag('continue?', autofill=True, default=False)
option: Str('exclude_groups*', autofill=True, cli_name='exclude_groups', default=[])
@@ -3225,25 +3218,6 @@ option: Str('version?')
output: Output('completed', type=[<type 'int'>])
output: Output('failed', type=[<type 'dict'>])
output: Entry('result')
-command: otptoken_add_yubikey
-args: 1,13,3
-arg: Str('ipatokenuniqueid?', cli_name='id')
-option: Str('addattr*', cli_name='addattr')
-option: Flag('all', autofill=True, cli_name='all', default=False)
-option: Str('description?', cli_name='desc')
-option: Bool('ipatokendisabled?', cli_name='disabled')
-option: DateTime('ipatokennotafter?', cli_name='not_after')
-option: DateTime('ipatokennotbefore?', cli_name='not_before')
-option: IntEnum('ipatokenotpdigits?', autofill=True, cli_name='digits', default=6, values=[6, 8])
-option: Str('ipatokenowner?', cli_name='owner')
-option: Flag('no_members', autofill=True, default=False)
-option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('setattr*', cli_name='setattr')
-option: IntEnum('slot?', cli_name='slot', values=[1, 2])
-option: Str('version?')
-output: Entry('result')
-output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
-output: PrimaryKey('value')
command: otptoken_del
args: 1,2,3
arg: Str('ipatokenuniqueid+', cli_name='id')
@@ -3326,15 +3300,6 @@ option: Str('version?')
output: Entry('result')
output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: PrimaryKey('value')
-command: otptoken_sync
-args: 1,5,1
-arg: Str('token?')
-option: Password('first_code', confirm=False)
-option: Password('password', confirm=False)
-option: Password('second_code', confirm=False)
-option: Str('user')
-option: Str('version?')
-output: Output('result')
command: output_find
args: 2,4,4
arg: Str('commandname', cli_name='command')
@@ -5664,11 +5629,10 @@ output: Output('completed', type=[<type 'int'>])
output: Output('failed', type=[<type 'dict'>])
output: Entry('result')
command: user_del
-args: 1,4,3
+args: 1,3,3
arg: Str('uid+', cli_name='login')
option: Flag('continue', autofill=True, cli_name='continue', default=False)
-option: Flag('no_preserve?', autofill=True, default=False)
-option: Flag('preserve?', autofill=True, default=False)
+option: Bool('preserve?')
option: Str('version?')
output: Output('result', type=[<type 'dict'>])
output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
@@ -5869,27 +5833,6 @@ option: Str('version?')
output: Output('result', type=[<type 'bool'>])
output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: PrimaryKey('value')
-command: vault_add
-args: 1,15,3
-arg: Str('cn', cli_name='name')
-option: Str('addattr*', cli_name='addattr')
-option: Flag('all', autofill=True, cli_name='all', default=False)
-option: Str('description?', cli_name='desc')
-option: Bytes('ipavaultpublickey?', cli_name='public_key')
-option: StrEnum('ipavaulttype?', autofill=True, cli_name='type', default=u'symmetric', values=[u'standard', u'symmetric', u'asymmetric'])
-option: Flag('no_members', autofill=True, default=False)
-option: Str('password?', cli_name='password')
-option: Str('password_file?', cli_name='password_file')
-option: Str('public_key_file?', cli_name='public_key_file')
-option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
-option: Str('setattr*', cli_name='setattr')
-option: Flag('shared?', autofill=True, default=False)
-option: Str('username?', cli_name='user')
-option: Str('version?')
-output: Entry('result')
-output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
-output: PrimaryKey('value')
command: vault_add_internal
args: 1,13,3
arg: Str('cn', cli_name='name')
@@ -5941,23 +5884,6 @@ option: Str('version?')
output: Output('completed', type=[<type 'int'>])
output: Output('failed', type=[<type 'dict'>])
output: Entry('result')
-command: vault_archive
-args: 1,11,3
-arg: Str('cn', cli_name='name')
-option: Flag('all', autofill=True, cli_name='all', default=False)
-option: Bytes('data?')
-option: Str('in?')
-option: Flag('override_password?', autofill=True, default=False)
-option: Str('password?', cli_name='password')
-option: Str('password_file?', cli_name='password_file')
-option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
-option: Flag('shared?', autofill=True, default=False)
-option: Str('username?', cli_name='user')
-option: Str('version?')
-output: Entry('result')
-output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
-output: PrimaryKey('value')
command: vault_archive_internal
args: 1,9,3
arg: Str('cn', cli_name='name')
@@ -6006,34 +5932,6 @@ output: Output('count', type=[<type 'int'>])
output: ListOfEntries('result')
output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: Output('truncated', type=[<type 'bool'>])
-command: vault_mod
-args: 1,22,3
-arg: Str('cn', cli_name='name')
-option: Str('addattr*', cli_name='addattr')
-option: Flag('all', autofill=True, cli_name='all', default=False)
-option: Flag('change_password?', autofill=True, default=False)
-option: Str('delattr*', cli_name='delattr')
-option: Str('description?', autofill=False, cli_name='desc')
-option: Bytes('ipavaultpublickey?', autofill=False, cli_name='public_key')
-option: StrEnum('ipavaulttype?', autofill=False, cli_name='type', default=u'symmetric', values=[u'standard', u'symmetric', u'asymmetric'])
-option: Str('new_password?', cli_name='new_password')
-option: Str('new_password_file?', cli_name='new_password_file')
-option: Flag('no_members', autofill=True, default=False)
-option: Str('old_password?', cli_name='old_password')
-option: Str('old_password_file?', cli_name='old_password_file')
-option: Bytes('private_key?', cli_name='private_key')
-option: Str('private_key_file?', cli_name='private_key_file')
-option: Str('public_key_file?', cli_name='public_key_file')
-option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Flag('rights', autofill=True, default=False)
-option: Str('service?')
-option: Str('setattr*', cli_name='setattr')
-option: Flag('shared?', autofill=True, default=False)
-option: Str('username?', cli_name='user')
-option: Str('version?')
-output: Entry('result')
-output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
-output: PrimaryKey('value')
command: vault_mod_internal
args: 1,15,3
arg: Str('cn', cli_name='name')
@@ -6087,23 +5985,6 @@ option: Str('version?')
output: Output('completed', type=[<type 'int'>])
output: Output('failed', type=[<type 'dict'>])
output: Entry('result')
-command: vault_retrieve
-args: 1,11,3
-arg: Str('cn', cli_name='name')
-option: Flag('all', autofill=True, cli_name='all', default=False)
-option: Str('out?')
-option: Str('password?', cli_name='password')
-option: Str('password_file?', cli_name='password_file')
-option: Bytes('private_key?', cli_name='private_key')
-option: Str('private_key_file?', cli_name='private_key_file')
-option: Flag('raw', autofill=True, cli_name='raw', default=False)
-option: Str('service?')
-option: Flag('shared?', autofill=True, default=False)
-option: Str('username?', cli_name='user')
-option: Str('version?')
-output: Entry('result')
-output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
-output: PrimaryKey('value')
command: vault_retrieve_internal
args: 1,7,3
arg: Str('cn', cli_name='name')