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

This function removes a link to an account at an external authentication identity provider.


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/remove_authn_link?provider=cpanelid&subject_unique_identifier=123456789012345678901

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 link from user account to the external authentication identity provider
$remove_external_link = $cpanel->uapi(
    'ExternalAuthentication', 'remove_authn_link',
    array(
        'provider'                     => 'cpanelid',
        'subject_unique_identifier' => '123456789012345678901'
          )
);

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 link from user account to the external authentication identity provider
my $remove_external_link = $cpliveapi->uapi(
    'ExternalAuthentication', 'remove_authn_link',
    {
        'provider'                     => 'cpanelid',
        'subject_unique_identifier' => '123456789012345678901'
    }
);

Note:

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

 

 cPanel Template Toolkit
<!-- Remove link from user account to the external authentication identity provider -->
[% data = execute( 'ExternalAuthentication', 'remove_authn_link', { 'provider' => 'cpanelid', 'subject_unique_identifier' => '123456789012345678901'} ); %]

Note:

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

 

 Command Line
uapi --user=username ExternalAuthentication remove_authn_link provider=cpanelid subject_unique_identifier=123456789012345678901

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.

   

ParameterTypeDescriptionPossible valuesExample
providerstring

Required

The name of the identity provider.

A valid string.

 

cpanelid
subject_unique_identifier
string

Required

The unique identifier for the user at the identity provider.

A valid string.

123456789012345678901

This function only returns metadata.