Page tree
Skip to end of metadata
Go to start of metadata

Description

This function removes a service account as a link candidate to create a subaccount or link to a subaccount. When you use this function, the system removes the Link option in cPanel's User Manager  interface (Home >> Preferences >> User Manager).

Examples


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/UserManager/dismiss_merge?username=example1&domain=example.com&services.ftp.dismiss=1

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 service account as a link candidate.
$Usermanager = $cpanel->uapi(
    'UserManager', 'dismiss_merge',
   array(
        'username'        		=> 'example1',
        'domain'          		=> 'example.com',
        'services.ftp.dismiss'  => '1',
        )
);

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 service account as a link candidate.
my $Usermanager = $cpliveapi->uapi(
    'UserManager', 'dismiss_merge',
   {
        'username'				=> 'example1',
        'domain'          		=> 'example.com',
        'services.ftp.dismiss'  => '1',
   }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Remove service account as a link candidate. -->
[% execute('UserManager', 'dismiss_merge', {'username' => 'example1', 'domain' => 'example.com', 'services.ftp.dismiss' => '1',} ) %]

Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 Command Line
uapi --user=username UserManager dismiss_merge username=example1 domain=example.com services.ftp.dismiss=1

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. 
  • We introduced this functionality in cPanel & WHM version 56.

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


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
username
string

Required

The username for the service account.

 

A username that meets the account name limitations.
  • Length — 64 characters.
  • Characters — a-z, A-Z, 0-9, (dot), (hyphen), (underscore).

Note:

This parameter does not include the domain name.

example1
domainstring

Required

The service account's associated domain.

A domain that the cPanel account owns.example.com
services.email.dismissBoolean

Whether to dismiss the merge of the email service account.

Note:

You must use at least one of the following parameters:

  • services.email.merge
  • services.ftp.merge
  • services.webdisk.merge

This parameter defaults to 0.

  • 1 — Dismiss.
  • 0 — Do not dismiss.

 

1
services.ftp.dismiss
Boolean

Whether to dismiss the merge of the FTP service account.

Note:

You must use at least one of the following parameters:

  • services.email.merge
  • services.ftp.merge
  • services.webdisk.merge

This parameter defaults to 0.

  • 1 — Dismiss.
  • 0 — Do not dismiss.
1
services.webdisk.dismiss Boolean

Whether to dismiss the merge of the Web Disk service account.

Note:

You must use at least one of the following parameters:

  • services.email.merge
  • services.ftp.merge
  • services.webdisk.merge

This parameter defaults to 0.

  • 1 — Dismiss.
  • 0 — Do not dismiss.
1

Returns

This function only returns metadata.