Difference between revisions of "Run command Api config"

From i2Rest
Jump to: navigation, search
(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...")
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{{DISPLAYTITLE:How to allow calls to run_command API}}
 +
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
 
;Step 1
−
:Register two users on IBM i.
+
: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
 
;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). С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>:
−
[[I2Rest_quick_config|Basic configuration]] management API variant (differences are highlighted in <span style="background:#e3f6d0;">green</span>):
 
  
 
  {
 
  {
 
     "gates":
 
     "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>"}
 
     },
 
     },
−
  <span style="background:#e3f6d0;">   "OAuth2":
+
    "session_systems":
 +
    [
 +
      <span style="background:#D3D3D3;">{ "name"  : "*LOCAL",
 +
          "submit" : SBMJOB JOB(I2RESTS)                            \
 +
                            USER(${user})                            \
 +
                            CMD(CALL I2REST                          \
 +
                              PARM('-session'                      \
 +
                                    '-url' '${surl}'                \
 +
                                    '-uid' '${uid}'                \
 +
                                    '-user' '${user}'))            \
 +
                                    '-init' 'ADDLIBLE I2REST'))"    \
 +
      }</span>
 +
    ]<span style="background:#D3D3D3;">,
 +
    "OAuth2":
 
     {
 
     {
−
       "scopes": {"management_functions" : {"description":"i2Rest management APIs call"}
+
       "scopes": {"run_command" : {"description":"IBM i command call"}},
−
      },
 
 
       "users":
 
       "users":
 
       {
 
       {
−
         "<span style="color:#22d3d3;">USRX</span>":{"description":"<span style="color:#22d3d3;">John Johnes</span>","valid_clients":{"<span style="color:#22d3d3;">TSTCLNT</span>":{"scopes":["management_functions"]}}}
+
         "<b>USRX</b>":{"description":"<b>John Johnes</b>","valid_clients":{"<b>TSTCLNT</b>":{"scopes":["run_command"]}}}
 
       },
 
       },
 
       "clients":
 
       "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",  
 
                     "description":"Test client",  
−
                     "valid_scopes":["management_functions"],
+
                     "valid_scopes":["run_command"],
 
                     "valid_grant_types":["authorization_code"]}
 
                     "valid_grant_types":["authorization_code"]}
−
       },
+
       }
−
      "tokens": {"type":"token"},"codes":{"type":"code"}
 
 
     }</span>  
 
     }</span>  
 
  }
 
  }
 +
 +
Now you are ready to [[I2Rest_Start|start]] serve run_command API.<br/>

Latest revision as of 20:39, 25 August 2020

This API allows you to call IBM i commands. Requests to this API must be authorized using OAuth2 token with "run_command" in its scope.

Step 1
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). Сopy and paste the snippet bellow. Replace with appropriate values highlighted with bold 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.
For clarity, differences with Basic configuration are highlighted in gray:
{
   "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)"}
   },
   "session_systems":
   [
      {  "name"   : "*LOCAL",
         "submit" : SBMJOB JOB(I2RESTS)                             \
                           USER(${user})                            \
                           CMD(CALL I2REST                          \
                              PARM('-session'                       \
                                    '-url' '${surl}'                \
                                    '-uid' '${uid}'                 \
                                    '-user' '${user}'))             \
                                    '-init' 'ADDLIBLE I2REST'))"    \
      } 
   ],
   "OAuth2":
   {
     "scopes": {"run_command" : {"description":"IBM i command call"}},
     "users":
     {
        "USRX":{"description":"John Johnes","valid_clients":{"TSTCLNT":{"scopes":["run_command"]}}}
     },
     "clients":
     {
        "TSTCLNT":{"redirect_uri":"<main gate URL>/oauth2/redirect", 
                   "description":"Test client", 
                   "valid_scopes":["run_command"],
                   "valid_grant_types":["authorization_code"]}
     }
   } 
}

Now you are ready to start serve run_command API.

Retrieved from "https://www.i2rest.com/index.php?title=Run_command_Api_config&oldid=1791"