We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - DirectoryPrivacy::delete_user
Skip to end of metadata
Go to start of metadata

Description

This function deletes a user who can access a protected directory on the cPanel account.

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/DirectoryPrivacy/delete_user?dir=/home/example/example.com&user=example1


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Remove a user who can access the /home/example/example.com directory.
$delete_user = $cpanel->uapi(
    'DirectoryPrivacy', 'delete_user',
    array(
        'dir'      => '/home/example/example.com',
		'user'     => 'example1',
  )
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Remove a user who can access the /home/example/example.com directory.
my $delete_user = $cpliveapi->uapi(
    'DirectoryPrivacy', 'delete_user',
    {
        'dir'      => '/home/example/example.com',
		'user'     => 'example1',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 Command Line
uapi --user=username DirectoryPrivacy delete_user dir=/home/example/example.com user=example1 


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{ 
   "errors":null,
   "data":null,
   "warnings":null,
   "status":1,
   "messages":null,
   "metadata":{ 

   }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
dirstring

Required

The directory from which to remove a user.

A valid absolute directory path on the cPanel account./home/example/example.com
user string

Required

The username to remove from the directory.

A valid username.example1 

Returns

This function only returns metadata.