CreateClientSsoToken

This action creates a one-time, automatic login link for the user ID you specify.

The duration of the generated connection is limited to "60 seconds".

Please also note that two-factor authentication (2FA) and CAPTCHA verification steps will not be applied during the login process.

Method / Endpoint

Request Parameters

External Sample

curl --location 'https://example.com/api/Clients/CreateClientSsoToken' \
--header 'Content-Type: application/json' \
--header 'Apikey: [YOUR_API_KEY]' \
--data '{
    "user_id": 18,
    "destination": "ac-ps-products",
    "destination_values" : []
}'

Internal Sample

Helper::Load("Api");
try {
    $result = Api::Clients()->CreateClientSsoToken([
        'user_id' => 18,
        'destination' => "ac-ps-products",
        'destination_values' => []
    ]);

    print_r($result);
}
catch (Exception $e)
{
    echo 'Error: '.$e->getMessage();
}

Sample JSON Response

{
    "status": "successful",
    "data": {
        "token": "QXU0K254M3c0L0Evdm0wSUFNaEsrZ0NoaWRmNE5BVnlWc3g3MjUwZ1pKSTRjU21oOExhWGROQnBtUDFPWDhzUmlHeitSOEFOZmxOcWI5Z0lBWFFjMHBscC8xQU1mMTJpdWx0M2FQU1krenMrdW9IVGlmZk9kZUdkbTVveElPSmZoUkpVNVUrVHhXZG5YQmpKSW1rWkRSM0ROaTQvNXpvZVcxL09qTnVHWW5icS85RkE0YmFSQXorTmlpUHV4cE54aWlNQWdzaDN0L1ZLQ3BFWlpzL2FWdz09",
        "url": "https://example.com/en/sign-in?sso_token=QXU0K254M3c0L0Evdm0wSUFNaEsrZ0NoaWRmNE5BVnlWc3g3MjUwZ1pKSTRjU21oOExhWGROQnBtUDFPWDhzUmlHeitSOEFOZmxOcWI5Z0lBWFFjMHBscC8xQU1mMTJpdWx0M2FQU1krenMrdW9IVGlmZk9kZUdkbTVveElPSmZoUkpVNVUrVHhXZG5YQmpKSW1rWkRSM0ROaTQvNXpvZVcxL09qTnVHWW5icS85RkE0YmFSQXorTmlpUHV4cE54aWlNQWdzaDN0L1ZLQ3BFWlpzL2FWdz09"
    }
}

Response Parameters

Destination

• This field is used to specify the address to which the user will be redirected when entering the one-click login link.
• If you do not define it, it will redirect to the customer panel homepage.
• If you define a URL address, it will be redirected to the URL address you specify.
• The values that the "destination" parameter can take are described in the table below.