Description


This function adds an External Authentication authorization link to an account.


Examples




https://hostname.example.com:2083/cpsess##########/execute/ExternalAuthentication/add_authn_link?username=example&provider_id=google&subject_unique_identifier=123456789012345678901&preferred_username=Example



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Adds external authentication links to the current account.
$add_links = $cpanel->uapi(
    'ExternalAuthentication', 'add_authn_links',    array(
        'username'                     => 'example',
        'provider_id'                  => 'google',
        'subject_unique_identifier'    => '123456789012345678901'
        'preferred_username'           => 'Example'
     )
);




my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Adds external authentication links to the current account.
my $add_links = $cpliveapi->uapi(
    'ExternalAuthentication', 'add_authn_link'(
        'username'                     => 'example',
        'provider_id'                  => 'google',
        'subject_unique_identifier'    => '123456789012345678901'
        'preferred_username'           => 'Example'
     )
);




uapi --user=username ExternalAuthentication add_authn_link username=example provider_id=google subject_unique_identifier=123456789012345678901 preferred_username=Example



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
}



   

Parameters

ParameterTypeDescriptionPossible ValuesExample
usernamestring

Required

The username.

A valid cPanel username on the server.example
provider_idstring

Required

The name of the identity provider.

A valid string.google
subject_unique_identifierstring

Required

The unique identifier for the user at the identity provider.

A valid string.
123456789012345678901
preferred_usernamestring

Required

The preferred username of the account on the identity provider.

A valid string.Example


Returns

This function only returns metadata.