Configuring OAuth2 authorization - Revision history

Alexei.baranov at 14:54, 14 June 2021

2021-06-14T14:54:42Z

Pavel.lobko at 11:11, 9 July 2020

2020-07-09T11:11:07Z

Pavel.lobko at 11:10, 9 July 2020

2020-07-09T11:10:21Z

Pavel.lobko at 09:59, 8 July 2020

2020-07-08T09:59:25Z

Alexei.baranov at 06:52, 8 July 2020

2020-07-08T06:52:43Z

Alexei.baranov at 06:41, 8 July 2020

2020-07-08T06:41:45Z

Pavel.lobko at 13:37, 6 July 2020

2020-07-06T13:37:04Z

Pavel.lobko at 13:35, 6 July 2020

2020-07-06T13:35:56Z

Pavel.lobko at 08:06, 1 July 2020

2020-07-01T08:06:00Z

Pavel.lobko at 13:28, 30 June 2020

2020-06-30T13:28:28Z

@@ Line 20: / Line 20: @@
+  {
      "gates":
+     {

← Older revision		Revision as of 11:11, 9 July 2020
Line 16:		Line 16:

	;Step 3		;Step 3
−	: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>:	+	: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>:

← Older revision		Revision as of 11:10, 9 July 2020
Line 16:		Line 16:

	;Step 3		;Step 3
−	: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 2: / Line 2: @@
 ;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
 :''This step is the same as in the basic example. You can skip this step if you've done the basic scenario.''<br/>Create text file named I2RESTECHO.PCML anywhere on IFS, for example "/tmp/PCML/i2restecho.pcml". Copy and paste following code. It represents a description for the sample program I2RESTECHO, that is included into i2Rest Server installation for demonstration purposes:

@@ Line 2: / Line 2: @@
 ;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
-:Create text file named I2RESTECHO.PCML anywhere on IFS, for example "/tmp/PCML/i2restecho.pcml". Copy and paste following code. It represents a description for the sample program I2RESTECHO, that is included into i2Rest Server installation for demonstration purposes:
+:''This step is the same as in the basic example. You can skip this step if you've done the basic scenario.''<br/>Create text file named I2RESTECHO.PCML anywhere on IFS, for example "/tmp/PCML/i2restecho.pcml". Copy and paste following code. It represents a description for the sample program I2RESTECHO, that is included into i2Rest Server installation for demonstration purposes:
 <pre>
 <pcml version="1.0">
@@ Line 16: / Line 16: @@
 ;Step 3
-: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 (must be a regestered IBM i user) and client (must be a regestered IBM i user) with appropriate values. We will start with simplest non-encrypted connections, so please leave http as a protocol.
+: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 37: / Line 36: @@
                                       '-user' '${user}')) \
                               INLLIBL(I2REST)"
-        },
+        }<span style="background:#D3D3D3;">,
-       <span style="background:#e3f6d0;">{  "name"   : "*LOCAL",
+       {  "name"   : "*LOCAL",
            "submit" : SBMJOB JOB(I2RESTS)                             \
                              USER(${user})                            \
@@ Line 53: / Line 52: @@
+        {
            "pcml_mount"         : "echo",
-           "pcml_file"          : "<span style="color:red;"><complete name of i2restecho.pcml on IFS (for example /tmp/PCML/i2restecho.pcml)></span>",
+           "pcml_file"          : "<b><complete name of i2restecho.pcml on IFS (for example /tmp/PCML/i2restecho.pcml)></b>",
            "valid_in_anonymous" : true
+        }
-     ],
+     ]<span style="background:#D3D3D3;">,
-    <span style="background:#e3f6d0;">"OAuth2":
+    "OAuth2":
+     {
         "scopes":
@@ Line 65: / Line 64: @@
         "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_program"]}}}
+           "<b>USRX</b>":{"description":"<b>John Johnes</b>","valid_clients":{"<b>TSTCLNT</b>":{"scopes":["run_program"]}}}
         },
         "clients":
+        {
-           "<span style="color:#D3D3D3;">TSTCLNT</span>":{"redirect_uri":"<span style="color:#D3D3D3;"><main gate URL></span>/oauth2/redirect",
+           "<b>TSTCLNT</b>":{"redirect_uri":"<b><main gate URL></b>/oauth2/redirect",
                      "description":"Test client",
                      "valid_scopes":["run_program"],
@@ Line 77: / Line 76: @@
      }</span>
+  }
-With "pcmls" object's <code> "valid_in_anonymous" : true</code> parameter unchanged, I2RESTECHO will be accessible to both anonymous and authorized request. To allow only authorized requests, <code> "valid_in_anonymous" : false</code> should be set.<br>
+With "pcmls" object's <code> "valid_in_anonymous" : true</code> parameter unchanged, I2RESTECHO will be accessible to both anonymous and authorized requests. To allow only authorized requests, set <code>"valid_in_anonymous" : false</code> and remove definition of <code>"*ANONYMOUS"</code> session system.<br/>
 Now you can update your [[I2Rest_Basic_Test#SOAP_UI|SoapUI  I2RESTECHO test project]] with [[Auth_profile_SoapUI|Authorization profile]] and perform your authorized API call.

← Older revision		Revision as of 06:41, 8 July 2020
Line 1:		Line 1:
−	Unlike ~~anonimous~~ API call we performed in our [[I2Rest_Server#basic_guide\|quick start guide]], authorized API call requires OAuth2 token with "run_program" [[I2Rest_scopes#\|scope]] and <code>*local</code> [[I2Rest_Gates#Session_System\|Session System]] defined.	+	Unlike anonymous API call we performed in our [[I2Rest_Server#basic_guide\|quick start guide]], authorized API call requires OAuth2 token with "run_program" [[I2Rest_scopes#\|scope]] and <code>*local</code> [[I2Rest_Gates#Session_System\|Session System]] defined.

	;Step 1		;Step 1

@@ Line 23: / Line 23: @@
      "gates":
+     {
-        "main"       : {"url":"http://<span style="color:red;"><host_name>[:port] (for example api.i2rest.com:1234)</span>"},
+        "main"       : {"url":"http://'''<host_name>[:port] (for example api.i2rest.com:1234)'''"},
-        "management" : {"url":"http://<span style="color:red;"><host_name>[:port] (for example api.i2rest.com:4321)</span>"}
+        "management" : {"url":"http://'''<host_name>[:port] (for example api.i2rest.com:4321)'''"}
      },
      "session_systems":