RADIUSdesk

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
2021:rd_api_permanent_users [2021/10/01 17:30] – [Alternative items to include in the POST] admin2021:rd_api_permanent_users [2021/10/03 07:00] (current) – [Activate & Expire] admin
Line 5: Line 5:
         * **realm_id** Each Permanent User has to belong to a Realm. A Realm is like a group but used by RADIUS.         * **realm_id** Each Permanent User has to belong to a Realm. A Realm is like a group but used by RADIUS.
         * **profile_id** Each Permanent User have to a Profile. A Profile can be used by RADIUS to dictate the service (bandwidth, amount of data available etc) a Permanent User will get when connecting to the Internet.         * **profile_id** Each Permanent User have to a Profile. A Profile can be used by RADIUS to dictate the service (bandwidth, amount of data available etc) a Permanent User will get when connecting to the Internet.
-  * So to recap. A Permanent User has to have:+  * So to recap, **BEFORE** you can create a Permanent User **MAKE SURE** you have the following items since they are compulsory:
         * An Owner         * An Owner
         * A Realm         * A Realm
Line 122: Line 122:
 </code> </code>
  
 +===== Adding a suffix to the username =====
 +  * You might have noticed that we specified the username as **demo2** but the name that was created has a **@demo1** added.
 +  * This is because of a setting we specified in the Realm we used.
 +  * See the following screenshot
 +{{:2021:realm_suffix.png?nolink|}}
 +  * Go ahead and remove the check for Permanent Users, save it and run the API call again.
 +  * The **@demo** should now be missing in the username.
  
 +===== Items allowed in the API =====
 +  * This section will list all the additional items that can be contained in the API call when adding a Permanent User.
 +  * The only compulsory ones are those discussed earlier in the document.
  
 +==== Personal Info ====
  
 +^ Item      ^ Typical Value       ^ Comment          ^
 +| name  |John    |varchar(50)  |
 +| surname  |Smith  |varchar(50)  |
 +| phone    |+27-724952041     |varchar(50) 
 +| language    | 4_4    | This is the only option available for now  |
 +| email    | john@radiusdesk.com   |varchar(100)  |
 +| address    | 25Main Road Henley On Klip   |varchar(255)  |
  
 +==== Activate & Expire ====
 +^ Item      ^ Typical Value       ^ Comment          ^
 +| from_date  |10/02/2021    |Month/Day/Year for  2 October 2021 use with **to_date** |
 +| to_date  |10/02/2022  |Month/Day/Year for 2 October 2021 use with **from_date** |
  
 +  * If these items are not specified, the account will be always active.
 +
 +==== Optional Items ====
 +^ Item      ^ Typical Value       ^ Comment          ^
 +| static_ip  |192.168.31.2    |This value will be send inside the RADIUS Access Accept in the form of **Framed-IP-Address = 192.168.31.2** and **Service-Type = Framed-User** |
 +| extra_name  |POPI-Act |varchar(100) available for your own use /convention |
 +| extra_value  |Yes  |varchar(100) available for your own use /convention |