ProSBC:Restful API User: Difference between revisions

Revision as of 04:27, 24 January 2023

You can create/modify a user in your system with RestFul API using JSON format. The JSON must be in the following format:

{
    "pass": "Abc_123@",
    "user_group": "Admin",
    "account_enabled": true,
    "email": "support@telcobridges.com",
    "***meta***": {
        "version": "3.1.137",
        "src_path": ""
    },
    "name": "support"
}

Important parameters in the JSON file

Adding a new User

You can add a new User with the POST command:

POST http://ProSBCIP:12358/users

ProSBC will create a new User from the name in the JSON file.

Example: We use the Postman tool in this example and the URL is:

http://192.168.1.25:12358/users

If the new User is created successfully, you will see the following information in the Postman Tool

@@ Line 16: / Line 16: @@
 Important parameters in the JSON file
-==List of Parameters==
 * [[Parameter: User Name|name]]
@@ Line 23: / Line 21: @@
 * [[Parameter: Email|email]]
 * [[Parameter: User Group|user_group]]
+==Adding a new User==
+You can add a new User with the POST command:
+POST http://ProSBCIP:12358/users
+ProSBC will create a new User from the name in the JSON file.
+Example: We use the Postman tool in this example and the URL is:
+http://192.168.1.25:12358/users
+[[Image:RestFul_user_Post_Send.png|800px| ]]
+If the new User is created successfully, you will see the following information in the Postman Tool
+[[Image:RestFul_user_Post_Response.png|800px| ]]