summaryrefslogtreecommitdiffstats
path: root/API.txt
diff options
context:
space:
mode:
authorThierry Bordaz <tbordaz@redhat.com>2015-04-16 11:56:11 +0200
committerMartin Kosek <mkosek@redhat.com>2015-05-18 09:37:21 +0200
commit4ef32967f76965e622780b9d6171b3e8896ec348 (patch)
tree63a9e1c4bc5a17cd9efabea33980c68d308914a6 /API.txt
parent699dd771022227644c631dcc17839dfe04077a8e (diff)
downloadfreeipa-4ef32967f76965e622780b9d6171b3e8896ec348.tar.gz
freeipa-4ef32967f76965e622780b9d6171b3e8896ec348.tar.xz
freeipa-4ef32967f76965e622780b9d6171b3e8896ec348.zip
User life cycle: user-del supports --permanently, --preserve options and ability to delete deleted user
change user plugin commands : user-del - --permanently: deletes permanently an Active user (DEL) - --preserve: move an Active user to Delete user (MODRDN) - allows to delete Active user and Delete user https://fedorahosted.org/freeipa/ticket/3813 Reviewed-By: David Kupka <dkupka@redhat.com>
Diffstat (limited to 'API.txt')
-rw-r--r--API.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/API.txt b/API.txt
index d7e4e0baa..d41f5bdc5 100644
--- a/API.txt
+++ b/API.txt
@@ -4539,9 +4539,11 @@ output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDA
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), None)
output: PrimaryKey('value', None, None)
command: user_del
-args: 1,2,3
+args: 1,4,3
arg: Str('uid', attribute=True, cli_name='login', maxlength=255, multivalue=True, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]{0,252}[a-zA-Z0-9_.$-]?$', primary_key=True, query=True, required=True)
option: Flag('continue', autofill=True, cli_name='continue', default=False)
+option: Flag('permanently?', autofill=True, cli_name='permanently', default=False)
+option: Flag('preserve?', autofill=True, cli_name='preserve', default=False)
option: Str('version?', exclude='webui')
output: Output('result', <type 'dict'>, None)
output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), None)