Description
This function removes a link to an account at an external authentication identity provider.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/remove_authn_link?provider=cpanelid&subject_unique_identifier=123456789012345678901
LiveAPI PHP Class
$cpanel = new CPANEL();
$remove_external_link = $cpanel->uapi(
'ExternalAuthentication', 'remove_authn_link',
array(
'provider' => 'cpanelid',
'subject_unique_identifier' => '123456789012345678901'
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $remove_external_link = $cpliveapi->uapi(
'ExternalAuthentication', 'remove_authn_link',
{
'provider' => 'cpanelid',
'subject_unique_identifier' => '123456789012345678901'
}
);
cPanel Template Toolkit
[% data = execute( 'ExternalAuthentication', 'remove_authn_link', { 'provider' => 'cpanelid', 'subject_unique_identifier' => '123456789012345678901'} ); %]
|
Command Line
uapi --user=username ExternalAuthentication remove_authn_link provider=cpanelid subject_unique_identifier=123456789012345678901
|
Output (JSON)
{
"messages": null,
"errors": null,
"status": 1,
"metadata": {
},
"data": null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
provider
|
string
|
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
|
Returns
This function only returns metadata.
