This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| 2021:rd_api_permanent_users [2021/10/01 17:08] – [Finding the detail of the items] admin | 2021: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 71: | Line 71: | ||
| * The list of Profiles are shown by calling this URL (Be sure to replace the token with your API Key) | * The list of Profiles are shown by calling this URL (Be sure to replace the token with your API Key) | ||
| * http:// | * http:// | ||
| + | * If there are a large amount of Profiles on the system you may have to add pager items to the URL but this beyond the scope of this document. | ||
| * Here is a sample reply | * Here is a sample reply | ||
| <code javascript> | <code javascript> | ||
| Line 87: | Line 88: | ||
| * We can either use **profile_id = 1** or **profile = demo1** when calling the API. The back-end is smart enough to convert the Profile name to to the Profile ID when adding the user. | * We can either use **profile_id = 1** or **profile = demo1** when calling the API. The back-end is smart enough to convert the Profile name to to the Profile ID when adding the user. | ||
| + | ==== Alternative items to include in the POST ==== | ||
| + | * The following is the **minimum** items (as an alternative based on the info above) than needs to be included in the POST request. | ||
| + | <code javascript> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | </ | ||
| + | ==== Reply from the server to the POST ==== | ||
| + | * If the request was successful the server will reply with the following | ||
| + | <code javascript> | ||
| + | { | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | ===== 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 | ||
| + | {{: | ||
| + | * 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 | ||
| + | | phone |+27-724952041 | ||
| + | | language | ||
| + | | email | john@radiusdesk.com | ||
| + | | address | ||
| + | |||
| + | ==== Activate & Expire ==== | ||
| + | ^ Item ^ Typical Value ^ Comment | ||
| + | | from_date | ||
| + | | to_date | ||
| + | |||
| + | * If these items are not specified, the account will be always active. | ||
| + | |||
| + | ==== Optional Items ==== | ||
| + | ^ Item ^ Typical Value ^ Comment | ||
| + | | static_ip | ||
| + | | extra_name | ||
| + | | extra_value | ||