diff options
Diffstat (limited to 'API.txt')
| -rw-r--r-- | API.txt | 128 |
1 files changed, 128 insertions, 0 deletions
@@ -3741,6 +3741,134 @@ option: Str('version?', exclude='webui') output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None)) output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), None) output: PrimaryKey('value', None, None) +command: stageuser_del +args: 1,2,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: Str('version?', exclude='webui') +output: Output('result', <type 'dict'>, None) +output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), None) +output: ListOfPrimaryKeys('value', None, None) +command: stageuser_find +args: 1,52,4 +arg: Str('criteria?', noextrawhitespace=False) +option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui') +option: Str('carlicense', attribute=True, autofill=False, cli_name='carlicense', multivalue=True, query=True, required=False) +option: Str('cn', attribute=True, autofill=False, cli_name='cn', multivalue=False, query=True, required=False) +option: Str('departmentnumber', attribute=True, autofill=False, cli_name='departmentnumber', multivalue=True, query=True, required=False) +option: Str('displayname', attribute=True, autofill=False, cli_name='displayname', multivalue=False, query=True, required=False) +option: Str('employeenumber', attribute=True, autofill=False, cli_name='employeenumber', multivalue=False, query=True, required=False) +option: Str('employeetype', attribute=True, autofill=False, cli_name='employeetype', multivalue=False, query=True, required=False) +option: Str('facsimiletelephonenumber', attribute=True, autofill=False, cli_name='fax', multivalue=True, query=True, required=False) +option: Str('gecos', attribute=True, autofill=False, cli_name='gecos', multivalue=False, query=True, required=False) +option: Int('gidnumber', attribute=True, autofill=False, cli_name='gidnumber', minvalue=1, multivalue=False, query=True, required=False) +option: Str('givenname', attribute=True, autofill=False, cli_name='first', multivalue=False, query=True, required=False) +option: Str('homedirectory', attribute=True, autofill=False, cli_name='homedir', multivalue=False, query=True, required=False) +option: Str('in_group*', cli_name='in_groups', csv=True) +option: Str('in_hbacrule*', cli_name='in_hbacrules', csv=True) +option: Str('in_netgroup*', cli_name='in_netgroups', csv=True) +option: Str('in_role*', cli_name='in_roles', csv=True) +option: Str('in_sudorule*', cli_name='in_sudorules', csv=True) +option: Str('initials', attribute=True, autofill=False, cli_name='initials', multivalue=False, query=True, required=False) +option: Str('ipatokenradiusconfiglink', attribute=True, autofill=False, cli_name='radius', multivalue=False, query=True, required=False) +option: Str('ipatokenradiususername', attribute=True, autofill=False, cli_name='radius_username', multivalue=False, query=True, required=False) +option: StrEnum('ipauserauthtype', attribute=True, autofill=False, cli_name='user_auth_type', csv=True, multivalue=True, query=True, required=False, values=(u'password', u'radius', u'otp')) +option: DateTime('krbprincipalexpiration', attribute=True, autofill=False, cli_name='principal_expiration', multivalue=False, query=True, required=False) +option: Str('krbprincipalname', attribute=True, autofill=False, cli_name='principal', multivalue=False, query=True, required=False) +option: Str('l', attribute=True, autofill=False, cli_name='city', multivalue=False, query=True, required=False) +option: Str('loginshell', attribute=True, autofill=False, cli_name='shell', multivalue=False, query=True, required=False) +option: Str('mail', attribute=True, autofill=False, cli_name='email', multivalue=True, query=True, required=False) +option: Str('manager', attribute=True, autofill=False, cli_name='manager', multivalue=False, query=True, required=False) +option: Str('mobile', attribute=True, autofill=False, cli_name='mobile', multivalue=True, query=True, required=False) +option: Flag('no_members', autofill=True, default=False, exclude='webui') +option: Str('not_in_group*', cli_name='not_in_groups', csv=True) +option: Str('not_in_hbacrule*', cli_name='not_in_hbacrules', csv=True) +option: Str('not_in_netgroup*', cli_name='not_in_netgroups', csv=True) +option: Str('not_in_role*', cli_name='not_in_roles', csv=True) +option: Str('not_in_sudorule*', cli_name='not_in_sudorules', csv=True) +option: Str('ou', attribute=True, autofill=False, cli_name='orgunit', multivalue=False, query=True, required=False) +option: Str('pager', attribute=True, autofill=False, cli_name='pager', multivalue=True, query=True, required=False) +option: Flag('pkey_only?', autofill=True, default=False) +option: Str('postalcode', attribute=True, autofill=False, cli_name='postalcode', multivalue=False, query=True, required=False) +option: Str('preferredlanguage', attribute=True, autofill=False, cli_name='preferredlanguage', multivalue=False, pattern='^(([a-zA-Z]{1,8}(-[a-zA-Z]{1,8})?(;q\\=((0(\\.[0-9]{0,3})?)|(1(\\.0{0,3})?)))?(\\s*,\\s*[a-zA-Z]{1,8}(-[a-zA-Z]{1,8})?(;q\\=((0(\\.[0-9]{0,3})?)|(1(\\.0{0,3})?)))?)*)|(\\*))$', query=True, required=False) +option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui') +option: Int('sizelimit?', autofill=False, minvalue=0) +option: Str('sn', attribute=True, autofill=False, cli_name='last', multivalue=False, query=True, required=False) +option: Str('st', attribute=True, autofill=False, cli_name='state', multivalue=False, query=True, required=False) +option: Str('street', attribute=True, autofill=False, cli_name='street', multivalue=False, query=True, required=False) +option: Str('telephonenumber', attribute=True, autofill=False, cli_name='phone', multivalue=True, query=True, required=False) +option: Int('timelimit?', autofill=False, minvalue=0) +option: Str('title', attribute=True, autofill=False, cli_name='title', multivalue=False, query=True, required=False) +option: Str('uid', attribute=True, autofill=False, cli_name='login', maxlength=255, multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]{0,252}[a-zA-Z0-9_.$-]?$', primary_key=True, query=True, required=False) +option: Int('uidnumber', attribute=True, autofill=False, cli_name='uid', minvalue=1, multivalue=False, query=True, required=False) +option: Str('userclass', attribute=True, autofill=False, cli_name='class', multivalue=True, query=True, required=False) +option: Password('userpassword', attribute=True, autofill=False, cli_name='password', exclude='webui', multivalue=False, query=True, required=False) +option: Str('version?', exclude='webui') +output: Output('count', <type 'int'>, None) +output: ListOfEntries('result', (<type 'list'>, <type 'tuple'>), Gettext('A list of LDAP entries', domain='ipa', localedir=None)) +output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), None) +output: Output('truncated', <type 'bool'>, None) +command: stageuser_mod +args: 1,44,3 +arg: Str('uid', attribute=True, cli_name='login', maxlength=255, multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]{0,252}[a-zA-Z0-9_.$-]?$', primary_key=True, query=True, required=True) +option: Str('addattr*', cli_name='addattr', exclude='webui') +option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui') +option: Str('carlicense', attribute=True, autofill=False, cli_name='carlicense', multivalue=True, required=False) +option: Str('cn', attribute=True, autofill=False, cli_name='cn', multivalue=False, required=False) +option: Str('delattr*', cli_name='delattr', exclude='webui') +option: Str('departmentnumber', attribute=True, autofill=False, cli_name='departmentnumber', multivalue=True, required=False) +option: Str('displayname', attribute=True, autofill=False, cli_name='displayname', multivalue=False, required=False) +option: Str('employeenumber', attribute=True, autofill=False, cli_name='employeenumber', multivalue=False, required=False) +option: Str('employeetype', attribute=True, autofill=False, cli_name='employeetype', multivalue=False, required=False) +option: Str('facsimiletelephonenumber', attribute=True, autofill=False, cli_name='fax', multivalue=True, required=False) +option: Str('gecos', attribute=True, autofill=False, cli_name='gecos', multivalue=False, required=False) +option: Int('gidnumber', attribute=True, autofill=False, cli_name='gidnumber', minvalue=1, multivalue=False, required=False) +option: Str('givenname', attribute=True, autofill=False, cli_name='first', multivalue=False, required=False) +option: Str('homedirectory', attribute=True, autofill=False, cli_name='homedir', multivalue=False, required=False) +option: Str('initials', attribute=True, autofill=False, cli_name='initials', multivalue=False, required=False) +option: Str('ipasshpubkey', attribute=True, autofill=False, cli_name='sshpubkey', csv=True, multivalue=True, required=False) +option: Str('ipatokenradiusconfiglink', attribute=True, autofill=False, cli_name='radius', multivalue=False, required=False) +option: Str('ipatokenradiususername', attribute=True, autofill=False, cli_name='radius_username', multivalue=False, required=False) +option: StrEnum('ipauserauthtype', attribute=True, autofill=False, cli_name='user_auth_type', csv=True, multivalue=True, required=False, values=(u'password', u'radius', u'otp')) +option: DateTime('krbprincipalexpiration', attribute=True, autofill=False, cli_name='principal_expiration', multivalue=False, required=False) +option: Str('l', attribute=True, autofill=False, cli_name='city', multivalue=False, required=False) +option: Str('loginshell', attribute=True, autofill=False, cli_name='shell', multivalue=False, required=False) +option: Str('mail', attribute=True, autofill=False, cli_name='email', multivalue=True, required=False) +option: Str('manager', attribute=True, autofill=False, cli_name='manager', multivalue=False, required=False) +option: Str('mobile', attribute=True, autofill=False, cli_name='mobile', multivalue=True, required=False) +option: Flag('no_members', autofill=True, default=False, exclude='webui') +option: Str('ou', attribute=True, autofill=False, cli_name='orgunit', multivalue=False, required=False) +option: Str('pager', attribute=True, autofill=False, cli_name='pager', multivalue=True, required=False) +option: Str('postalcode', attribute=True, autofill=False, cli_name='postalcode', multivalue=False, required=False) +option: Str('preferredlanguage', attribute=True, autofill=False, cli_name='preferredlanguage', multivalue=False, pattern='^(([a-zA-Z]{1,8}(-[a-zA-Z]{1,8})?(;q\\=((0(\\.[0-9]{0,3})?)|(1(\\.0{0,3})?)))?(\\s*,\\s*[a-zA-Z]{1,8}(-[a-zA-Z]{1,8})?(;q\\=((0(\\.[0-9]{0,3})?)|(1(\\.0{0,3})?)))?)*)|(\\*))$', required=False) +option: Flag('random', attribute=False, autofill=True, cli_name='random', default=False, multivalue=False, required=False) +option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui') +option: Str('rename', cli_name='rename', maxlength=255, multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]{0,252}[a-zA-Z0-9_.$-]?$', primary_key=True, required=False) +option: Flag('rights', autofill=True, default=False) +option: Str('setattr*', cli_name='setattr', exclude='webui') +option: Str('sn', attribute=True, autofill=False, cli_name='last', multivalue=False, required=False) +option: Str('st', attribute=True, autofill=False, cli_name='state', multivalue=False, required=False) +option: Str('street', attribute=True, autofill=False, cli_name='street', multivalue=False, required=False) +option: Str('telephonenumber', attribute=True, autofill=False, cli_name='phone', multivalue=True, required=False) +option: Str('title', attribute=True, autofill=False, cli_name='title', multivalue=False, required=False) +option: Int('uidnumber', attribute=True, autofill=False, cli_name='uid', minvalue=1, multivalue=False, required=False) +option: Str('userclass', attribute=True, autofill=False, cli_name='class', multivalue=True, required=False) +option: Password('userpassword', attribute=True, autofill=False, cli_name='password', exclude='webui', multivalue=False, required=False) +option: Str('version?', exclude='webui') +output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None)) +output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), None) +output: PrimaryKey('value', None, None) +command: stageuser_show +args: 1,5,3 +arg: Str('uid', attribute=True, cli_name='login', maxlength=255, multivalue=False, pattern='^[a-zA-Z0-9_.][a-zA-Z0-9_.-]{0,252}[a-zA-Z0-9_.$-]?$', primary_key=True, query=True, required=True) +option: Flag('all', autofill=True, cli_name='all', default=False, exclude='webui') +option: Flag('no_members', autofill=True, default=False, exclude='webui') +option: Flag('raw', autofill=True, cli_name='raw', default=False, exclude='webui') +option: Flag('rights', autofill=True, default=False) +option: Str('version?', exclude='webui') +output: Entry('result', <type 'dict'>, Gettext('A dictionary representing an LDAP entry', domain='ipa', localedir=None)) +output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), None) +output: PrimaryKey('value', None, None) command: sudocmd_add args: 1,7,3 arg: Str('sudocmd', attribute=True, cli_name='command', multivalue=False, primary_key=True, required=True) |