UAPI Functions - UserManager::unlink_service_account

This function unlinks a service account from a subaccount.

 cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/UserManager/unlink_service_account?username=example1&domain=example.com&service=ftp

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Unlink the service account from the subaccount.
$Usermanager = $cpanel->uapi(
    'UserManager', 'unlink_service_account',
   array(
        'username'        => 'example1',
        'domain'          => 'example.com',
        'service'         => 'ftp',
        )
);

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Unlink the service account from the subaccount.
my $Usermanager = $cpliveapi->uapi(
    'UserManager', 'unlink_service_account',
   {
        'username'        => 'example1',
        'domain'          => 'example.com',
        'service'         => 'ftp',
   }
);

 cPanel Template Toolkit
<!-- Unlink the service account from the subaccount. -->
[% execute('UserManager', 'unlink_service_account', {'username' => 'example1', 'domain' => 'example.com', 'service' => 'ftp',} ) %]

 Command Line
uapi --user=username UserManager unlink_service_account username=example1 domain=example.com service=ftp

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

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

 

Note:

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

 

 Parameter 

Type

Description

Possible values

Example

username

string

Required

The subaccount's username.

 

A username that meets the account name limitations.

  • Length — 64 characters
  • Characters — a-z, A-Z, 0-9, dot (.), hyphen (-), underscore (_)

Note:

This value does notinclude the domain name.

example

domain

string

Required

The subaccount's associated domain.

A domain that the cPanel account owns.

 example.com 

service

string

Required

The service to unlink.
  • email
  • ftp
  • webdisk

ftp

dismiss

 Boolean 

Whether to dismiss the service account as a merge candidate.

Note:

If any email, FTP, or Web Disk accounts use the same username, cPanel's User Manager interface (Home >> Preferences >> User Manager) allows you to merge those accounts into a subaccount. 

This parameter defaults to 0.
  • 1 — Dismiss as merge candidate.
  • 0 — Display as merge candidate.

0

 

This function only returns metadata.

  • 13 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....