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

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


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

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.
 
// 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'
     )
);

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.
 
# 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'
     )
);

Note:

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

 

 cPanel Template Toolkit
<!-- Adds external authentication links to the current account. -->
[% data = execute( 'ExternalAuthentication', 'add_authn_link','username' => 'example', 'provider_id' => 'google', 'subject_unique_identifier' => '123456789012345678901', 'preferred_username' => 'Example'); %]

Note:

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

 

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

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":{  

   },
}

Note:

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

   

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

 

This function only returns metadata.