Description
This function adds an External Authentication authorization link to an account.
Examples
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
LiveAPI PHP Class
$cpanel = new CPANEL();
$add_links = $cpanel->uapi(
'ExternalAuthentication', 'add_authn_links', array(
'username' => 'example',
'provider_id' => 'google',
'subject_unique_identifier' => '123456789012345678901'
'preferred_username' => 'Example'
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $add_links = $cpliveapi->uapi(
'ExternalAuthentication', 'add_authn_link'(
'username' => 'example',
'provider_id' => 'google',
'subject_unique_identifier' => '123456789012345678901'
'preferred_username' => 'Example'
)
);
cPanel Template Toolkit
[% data = execute( 'ExternalAuthentication', 'add_authn_link','username' => 'example', 'provider_id' => 'google', 'subject_unique_identifier' => '123456789012345678901', 'preferred_username' => 'Example'); %]
Command Line
uapi --user=username ExternalAuthentication add_authn_link username=example provider_id=google subject_unique_identifier=123456789012345678901 preferred_username=Example
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
},
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible Values
|
Example
|
|
username
|
string
|
Required
The username.
|
A valid cPanel username on the server.
|
example
|
|
provider_id
|
string
|
Required
The name of the identity provider.
|
A valid string.
|
google
|
|
subject_unique_identifier
|
string
|
Required
The unique identifier for the user at the identity provider.
|
A valid string.
|
123456789012345678901
|
|
preferred_username
|
string
|
Required
The preferred username of the account on the identity provider.
|
A valid string.
|
Example
|
Returns
This function only returns metadata.
