Permanent Users

This is an old revision of the document!

A Permanent User has to belong to a Profile and Realm in order to be useful to RADIUS.
In the previous Wiki Pages we already covered adding a Profile and a Realm.
In this page we will show you how to add a Permanent User to a Cloud in RADIUSdesk using an API call.
We will use PHP but the principles can be applied using any programming language.

Below is a simple as possible script that can be used as reference when adding a Permanent User using the API.
We also show the optional fields that can be included in the API call.

<?php
 
    // Configuration
    $api_url    = 'http://127.0.0.1/cake4/rd_cake/permanent-users/add.json';
    $token      = 'b4c6ac81-8c7c-4802-b50a-0a6380555b50';
    $cloud_id   = 23; // replace with the Cloud ID that you want to work on.
    $username   = 'testuser';
    $password   = 'testing123';
    $realm      = 'Dev';
    $profile    = 'MzanziFibre-12/1';
 
    // Set API payload
    $payload = [
 
        //Required Fields     
        'username'  => $username,
        'password'  => $password,
        'realm'     => $realm,
        'profile'   => $profile,
        'cloud_id'  => $cloud_id,
        'token'     => $token,
        'active'    => 'active', //active flag must be set for user to authenticate      
 
       /*        
       //Optional Fields  
        'name'          => '',
        'surname'       => '',     
        'phone'         => '',
        'email'         => '',
        'address'       => '',
        'from_date'     => '04/12/2025',
        'to_date'       => ''04/12/2026',
        'realm_id'	    => 19, //Alternative to Realm's name
        'profile_id'    => 49, //Alternative to Profile's name
        'static_ip'     => '192.168.1.100'
        'extra_name'    => '',
        'extra_value'   => '',
        'site'          => '',
        'ppsk'          => '',
        'auto_add'      => 'auto_add' //flag to automatically add the MAC Address the user connects with as a Device (BYOD) belonging to him
        */
    ];
 
    $json_payload = json_encode($payload);
    $ch = curl_init($api_url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $json_payload);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
 
    $response = curl_exec($ch);
    curl_close($ch);
    echo "Added $username: $response\n";
 
?>

Now that we have created a Permanent User, we will cover some common actions that can be done on the Permanent User via the API.

Permanent Users

Add a Permanent User using the API