ProSBC:Restful API User: Difference between revisions
(Created page with "You can create/modify a user in your system with RestFul API using JSON format. The JSON must be in the following format: <pre> { "pass": "Abc_123@", "user_group": "A...") |
mNo edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
You can create | You can create or modify a user in your system with the RESTful API using JSON format, in the following format: | ||
<pre> | <pre> | ||
| Line 16: | Line 16: | ||
Important parameters in the JSON file | Important parameters in the JSON file | ||
* [[Parameter: User Name|name]] | * [[Parameter: User Name|name]] | ||
| Line 23: | Line 21: | ||
* [[Parameter: Email|email]] | * [[Parameter: Email|email]] | ||
* [[Parameter: User Group|user_group]] | * [[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: Using the Postman tool, the URL is: | |||
http://192.168.1.25:12358/users | |||
[[Image:RestFul_user_Post_Send.png|800px| ]] | |||
If the new User is created successfully, the following message is returned in the Postman Tool | |||
[[Image:RestFul_user_Post_Response.png|800px| ]] | |||
==Modifiying a User== | |||
You can modify the existing User with the PUT command: | |||
PUT http://ProSBCIP:12358/users/user_name | |||
Example: Using the Postman tool, the URL is: | |||
http://192.168.1.25:12358/users/support we change the support account password to 123@Abc!9 | |||
[[Image:User_Put_Send.png|800px| ]] | |||
If the update is successful, the following message is returned in the Postman Tool | |||
[[Image:User_Put_Response.png|800px| ]] | |||
Learn more about how to use RESTful API and Postman Tool from the following link [[Northbound_interface:RESTful]]. | |||
Latest revision as of 11:50, 3 March 2023
You can create or modify a user in your system with the RESTful API using JSON format, 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: Using the Postman tool, the URL is:
http://192.168.1.25:12358/users
If the new User is created successfully, the following message is returned in the Postman Tool
Modifiying a User
You can modify the existing User with the PUT command:
PUT http://ProSBCIP:12358/users/user_name
Example: Using the Postman tool, the URL is:
http://192.168.1.25:12358/users/support we change the support account password to 123@Abc!9
If the update is successful, the following message is returned in the Postman Tool
Learn more about how to use RESTful API and Postman Tool from the following link Northbound_interface:RESTful.