Run command Api config - Revision history

Alexei.baranov at 17:39, 25 August 2020

2020-08-25T17:39:37Z

Pavel.lobko at 11:12, 9 July 2020

2020-07-09T11:12:05Z

Pavel.lobko at 06:18, 9 July 2020

2020-07-09T06:18:31Z

Alexei.baranov at 07:09, 8 July 2020

2020-07-08T07:09:48Z

Pavel.lobko at 08:02, 1 July 2020

2020-07-01T08:02:07Z

Pavel.lobko at 08:01, 1 July 2020

2020-07-01T08:01:12Z

Pavel.lobko at 14:11, 30 June 2020

2020-06-30T14:11:35Z

Pavel.lobko at 14:10, 30 June 2020

2020-06-30T14:10:41Z

Pavel.lobko at 14:07, 30 June 2020

2020-06-30T14:07:19Z

Pavel.lobko: Created page with " ;Step 1 :Register two users on IBM i. ;Step 2 :Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "manageme..."

2020-06-30T13:41:37Z

Created page with " ;Step 1 :Register two users on IBM i. ;Step 2 :Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "manageme..."

New page

;Step 1
:Register two users on IBM i.
;Step 2
:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports, user (must be a regestered IBM i user) and client (must be a regestered IBM i user) with appropriate values.
[[I2Rest_quick_config|Basic configuration]] management API variant (differences are highlighted in green):

{
"gates":
{
"main" : {"url":"http://<host_name>[:port] (for example api.i2rest.com:1234)"},
"management" : {"url":"http://<host_name>[:port] (for example api.i2rest.com:4321)"}
},
 "OAuth2":
{
"scopes": {"management_functions" : {"description":"i2Rest management APIs call"}
},
"users":
{
"USRX":{"description":"John Johnes","valid_clients":{"TSTCLNT":{"scopes":["management_functions"]}}}
},
"clients":
{
"TSTCLNT":{"redirect_uri":"<main gate URL>/oauth2/redirect",
"description":"Test client",
"valid_scopes":["management_functions"],
"valid_grant_types":["authorization_code"]}
},
"tokens": {"type":"token"},"codes":{"type":"code"}
}
}

← Older revision		Revision as of 17:39, 25 August 2020
Line 43:		Line 43:
	}		}

−	Now you are ready to [[I2Rest_Start\|start]] ~~serving~~ run_command API.<br/>	+	Now you are ready to [[I2Rest_Start\|start]] serve run_command API.<br/>

@@ Line 5: / Line 5: @@
 :Register two users on IBM i. The first will be used as a demonstrative OAuth2 resource owner, and the second one as an OAuth2 client.
 ;Step 2
-:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports, pcml_file, user (resource owner) and client (highlighted with <b>bold</b>) with appropriate values. We will start with simplest non-encrypted connections, so please leave http as a protocol.<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Сopy and paste the snippet bellow. Replace with appropriate values highlighted with <b>bold</b> parts: host_name, ports, pcml_file, user (resource owner) and client. We will start with simplest non-encrypted connections, so please leave http as a protocol.<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+  {
@@ Line 44: / Line 44: @@
 Now you are ready to [[I2Rest_Start|start]] serving run_command API.<br/>

@@ Line 3: / Line 3: @@
 ;Step 1
-:Register two users on IBM i. One will be used as a demonstrative OAuth2 resource owner, and the second one as an OAuth2 client.
+:Register two users on IBM i. The first will be used as a demonstrative OAuth2 resource owner, and the second one as an OAuth2 client.
 ;Step 2
 :Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports, pcml_file, user (resource owner) and client (highlighted with <b>bold</b>) with appropriate values. We will start with simplest non-encrypted connections, so please leave http as a protocol.<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:How to allow calls to run_command API}}
-This API allows you to call IBM i commands, OAuth2 token with run_command [[I2Rest_scopes#|scope]] is required.
+This API allows you to call IBM i commands. Requests to this API must be authorized using OAuth2 token with "run_command" in its [[I2Rest_scopes#|scope]].
 ;Step 1
-:Register two users on IBM i.
+:Register two users on IBM i. One will be used as a demonstrative OAuth2 resource owner, and the second one as an OAuth2 client.
 ;Step 2
-:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports, user (must be a regestered IBM i user) and client (must be a regestered IBM i user) with appropriate values.
+:Contact your system administrator for your IBM i server host name (or IP) and ''two'' available ports for "main" and "management" gates of your first i2Rest Server instance. Create file config.json (you can name it with any name and put it into any available IFS folder). Enter following text, replace host_name, ports, pcml_file, user (resource owner) and client (highlighted with <b>bold</b>) with appropriate values. We will start with simplest non-encrypted connections, so please leave http as a protocol.<br/>For clarity, differences with [[I2Rest_quick_config|Basic configuration]] are highlighted in <span style="background:#D3D3D3;">gray</span>:
+  {
      "gates":
+     {
-        "main"       : {"url":"http://<span style="color:#22d3d3;"><host_name>[:port] (for example api.i2rest.com:1234)</span>"},
+        "main"       : {"url":"http://<b><host_name>[:port] (for example api.i2rest.com:1234)</b>"},
-        "management" : {"url":"http://<span style="color:#22d3d3;"><host_name>[:port] (for example api.i2rest.com:4321)</span>"}
+        "management" : {"url":"http://<b><host_name>[:port] (for example api.i2rest.com:4321)</b>"}
      },
      "session_systems":
+     [
-        <span style="background:#e3f6d0;">{  "name"   : "*LOCAL",
+        <span style="background:#D3D3D3;">{  "name"   : "*LOCAL",
            "submit" : SBMJOB JOB(I2RESTS)                             \
                              USER(${user})                            \
@@ Line 26: / Line 25: @@
                                       '-init' 'ADDLIBLE I2REST'))"    \
         }</span>
-     ],
+     ]<span style="background:#D3D3D3;">,
- <span style="background:#e3f6d0;">   "OAuth2":
+    "OAuth2":
+     {
-       "scopes": {"run_command" : {"description":"IBM i command call"}
+       "scopes": {"run_command" : {"description":"IBM i command call"}},
        "users":
+       {
-          "<span style="color:#22d3d3;">USRX</span>":{"description":"<span style="color:#22d3d3;">John Johnes</span>","valid_clients":{"<span style="color:#22d3d3;">TSTCLNT</span>":{"scopes":["run_command"]}}}
+          "<b>USRX</b>":{"description":"<b>John Johnes</b>","valid_clients":{"<b>TSTCLNT</b>":{"scopes":["run_command"]}}}
        },
        "clients":
+       {
-          "<span style="color:#22d3d3;">TSTCLNT</span>":{"redirect_uri":"<span style="color:#22d3d3;"><main gate URL></span>/oauth2/redirect",
+          "<b>TSTCLNT</b>":{"redirect_uri":"<b><main gate URL></b>/oauth2/redirect",
                      "description":"Test client",
                      "valid_scopes":["run_command"],
                      "valid_grant_types":["authorization_code"]}
-       },
      }</span>
+  }

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:How to allow calls to run_command API}}
-This API allows you to call IBM i commands, OAuth2 token with run_command scope is required.
+This API allows you to call IBM i commands, OAuth2 token with run_command [[I2Rest_scopes#|scope]] is required.
 ;Step 1