This HTML5 document contains 10 embedded RDF statements represented using HTML+Microdata notation.

The embedded RDF content will be recognized by any processor of HTML5 Microdata.

Subject Item

n2:disable

rdf:type

schema:EntryPoint

schema:httpMethod

GET

schema:contentType

text/xml

n5:isWebServiceOf

n6:this_ODSUserModuleAPI

n5:endPointURL

n4:disable

schema:shortDescription

<p>Disable a user account. </p>

n5:hasParameter

n7:_name

schema:name

EntryPoint - user_disable

schema:description

<p>This function allows an administrator to disable a user account. A disabled user account does not allow authentication anymore, however all data is kept. Use <ref kindref="member" refid="group__ods__module__user_1gaaeccd6c639e21209915c5d1f846f4925">user.delete()</ref> to permanently delete an account and <ref kindref="member" refid="group__ods__module__user_1ga1c155be33ae582553ab7ddd8e2b85a5c">user.enable()</ref> to re-enable a disabled account. If the given <computeroutput>name</computeroutput> is not the authenticated user administrator privileges are required.</p><p><parameterlist kind="param"><li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The name of the user account to disable. If omitted the authenticated user account is disabled.</p></parameterdescription> </li> </ul> <simplesect kind="return"><p>An error code stating the success of the command execution as detailed in <ref kindref="member" refid="ods_response_format_1ods_response_format_result_code">ODS Error Result Codes</ref>.</p></simplesect> <simplesect kind="see"><p><ref kindref="member" refid="group__ods__module__user_1ga1c155be33ae582553ab7ddd8e2b85a5c">user.enable()</ref></p></simplesect> <simplesect kind="par"><title>Authentication</title><p>This function requries authentication via one of the supported authentication methods as described in <ref kindref="compound" refid="ods_authentication">ODS Authentication</ref>. </p></simplesect> </p>

schema:url

n4:disable