ProSBC:Restful API User - Revision history

Allyntree at 15:50, 3 March 2023

2023-03-03T15:50:38Z

← Older revision		Revision as of 11:50, 3 March 2023
Line 1:		Line 1:
	You can create or modify a user in your system with the ~~RestFul~~ API using JSON format~~. The JSON must be~~ in the following format:		You can create or modify a user in your system with the RESTful API using JSON format, in the following format:

	<pre>		<pre>
Line 30:		Line 30:
	ProSBC will create a new User from the name in the JSON file.		ProSBC will create a new User from the name in the JSON file.

	Example: ~~We use~~ the Postman tool ~~and~~ the URL is:		Example: Using the Postman tool, the URL is:

	http://192.168.1.25:12358/users		http://192.168.1.25:12358/users
Line 46:		Line 46:
	PUT http://ProSBCIP:12358/users/user_name		PUT http://ProSBCIP:12358/users/user_name

	Example: ~~We use~~ the Postman tool ~~in this example and~~ the URL is:		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		http://192.168.1.25:12358/users/support we change the support account password to 123@Abc!9
Line 57:		Line 57:


	~~You can learn~~ more about how to use ~~RestFul~~ API and Postman Tool from the following link [[Northbound_interface:RESTful]].		Learn more about how to use RESTful API and Postman Tool from the following link [[Northbound_interface:RESTful]].

Allyntree at 17:02, 1 March 2023

2023-03-01T17:02:33Z

← Older revision		Revision as of 13:02, 1 March 2023
Line 1:		Line 1:
	You can create/modify a user in your system with RestFul API using JSON format. The JSON must be in the following format:		You can create or modify a user in your system with the RestFul API using JSON format. The JSON must be in the following format:

	<pre>		<pre>
Line 30:		Line 30:
	ProSBC will create a new User from the name in the JSON file.		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:		Example: We use the Postman tool and the URL is:

	http://192.168.1.25:12358/users		http://192.168.1.25:12358/users
Line 36:		Line 36:
	[[Image:RestFul_user_Post_Send.png\|800px\| ]]		[[Image:RestFul_user_Post_Send.png\|800px\| ]]

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

	[[Image:RestFul_user_Post_Response.png\|800px\| ]]		[[Image:RestFul_user_Post_Response.png\|800px\| ]]
Line 46:		Line 46:
	PUT http://ProSBCIP:12358/users/user_name		PUT http://ProSBCIP:12358/users/user_name

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

	http://192.168.1.25:12358/users/support we change the support account password to 123@Abc!9		http://192.168.1.25:12358/users/support we change the support account password to 123@Abc!9
Line 52:		Line 52:
	[[Image:User_Put_Send.png\|800px\| ]]		[[Image:User_Put_Send.png\|800px\| ]]

	If the update is successful ~~you will see~~ the following ~~information~~ in the Postman Tool		If the update is successful, the following message is returned in the Postman Tool

	[[Image:User_Put_Response.png\|800px\| ]]		[[Image:User_Put_Response.png\|800px\| ]]


	You can ~~get~~ more ~~information~~ about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]]		You can learn more about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]].

Serdar Civici at 09:43, 24 January 2023

2023-01-24T09:43:51Z

← Older revision		Revision as of 05:43, 24 January 2023
Line 45:		Line 45:

	PUT http://ProSBCIP:12358/users/user_name		PUT http://ProSBCIP:12358/users/user_name

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

Serdar Civici at 08:33, 24 January 2023

2023-01-24T08:33:47Z

← Older revision		Revision as of 04:33, 24 January 2023
Line 39:		Line 39:

	[[Image:RestFul_user_Post_Response.png\|800px\| ]]		[[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: We use the Postman tool in this example and 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 you will see the following information in the Postman Tool

			[[Image:User_Put_Response.png\|800px\| ]]


			You can get more information about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]]

Serdar Civici at 08:27, 24 January 2023

2023-01-24T08:27:13Z

@@ Line 16: / Line 16: @@
 Important parameters in the JSON file
 * [[Parameter: User Name|name]]
@@ Line 23: / Line 21: @@
 * [[Parameter: Email|email]]
 * [[Parameter: User Group|user_group]]

Serdar Civici: 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:

 {     "pass": "Abc_123@",     "user_group": "A..."

2023-01-24T08:23:38Z

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..."

New page

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": "Admin",
"account_enabled": true,
"email": "support@telcobridges.com",
"***meta***": {
"version": "3.1.137",
"src_path": ""
},
"name": "support"
}
</pre>

Important parameters in the JSON file

==List of Parameters==

* [[Parameter: User Name|name]]
* [[Parameter: Password|pass]]
* [[Parameter: Email|email]]
* [[Parameter: User Group|user_group]]