I2Rest Client command - Revision history

Alexei.baranov at 04:19, 26 August 2020

2020-08-26T04:19:11Z

2020-07-09T07:48:29Z

2020-05-28T13:36:57Z

‎Parameters

2020-05-28T12:14:35Z

‎Parameters

2020-05-28T12:01:48Z

‎Parameters

2020-05-28T11:58:24Z

‎Parameters

2020-05-28T11:50:03Z

‎Parameters

2020-05-28T11:24:42Z

‎Parameters

2020-05-28T10:33:52Z

‎Parameters

2020-05-28T10:00:46Z

‎Examples

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:i2Rest command description}}
 === Parameters ===
 {| class="wikitable"

← Older revision		Revision as of 07:48, 9 July 2020
Line 224:		Line 224:
	<div id="BRIDGEPW"></div>'''i2Rest bridge client passwd''' (BRIDGEPW)<BR>		<div id="BRIDGEPW"></div>'''i2Rest bridge client passwd''' (BRIDGEPW)<BR>
	Password to be used authenticating i2rest Client with i2Rest Server in Authorization Code flow. Used with *BRIDGE authorization method.		Password to be used authenticating i2rest Client with i2Rest Server in Authorization Code flow. Used with *BRIDGE authorization method.
−
−	~~=== Examples ===~~
−	~~'''Example 1 Device flow'''<BR>~~
−	~~<pre>~~
−	~~I2REST COMMAND(*POST)~~
−	~~URL('http://192.168.0.233:8080')~~
−	~~BODY(*N '{"command":"STATUS"}'~~
−	~~'application/json' *YES 1208)~~
−	~~OUTPUT(*BOTH)~~
−	~~TOKENS('/qsys.lib/qtemp.lib/tokens.usrspc')~~
−	~~PROMPT(*REQUESTER)~~
−	~~ASK(*REQUESTER)~~
−	~~AUTHID(OAUTH21)~~
−	~~AUTHPW(oauth21)~~
−	~~AUTHURL('http://i2rest.com:22088/oauth2/device')~~
−	~~TOKENURL('http://i2rest.com:22088/oauth2/access')~~
−	~~SCOPE(manager_functions)~~
−	~~</pre>~~
−
−	~~=== todo ===~~
−	~~[[I2Rest_Client_messages\|Error messages]]~~
−	~~----~~
−	~~[[I2Rest_Client\|Back to i2Rest Client]]~~

@@ Line 207: / Line 207: @@
 Specify OAuth2 client/device password to be authentificated with authorization server.
-<div id="TOKENURL"></div>'''OAuth2 authorization endpoint''' (TOKENURL)<BR>
+<div id="AUTHURL"></div>'''OAuth2 authorization endpoint''' (AUTHURL)<BR>
 Specify URI to be requested for OAuth2 client/device authorization.

@@ Line 178: / Line 178: @@
 <div id="TOKENS"></div>'''Tokens storage''' (TOKENS)<BR>
-Path to token storage file. Either IFS or LIB file system approach (ex. - '/qsys.lib/qtemp.lib/tokens.usrspc') could be applied. If
+Path to token storage file. Either IFS or LIB file system approach (ex. - '/qsys.lib/qtemp.lib/tokens.usrspc') could be applied. If not provided, every request with *OAUTH2D, *OAUTH2C and *BRIDGE authorization method will perform authorization flow to obtain new token. Refresh token flows are also not allowed without correct token storage file path provided.
 <div id="REUSE"></div>'''Try to use saved token''' (REUSE)<BR>

@@ Line 83: / Line 83: @@
 |-
 |style="color: #8080FF; font-weight: bold;»|BRIDGEPW || i2Rest bridge client password ||	Character value
 |}

@@ Line 216: / Line 216: @@
 <div id="SCOPE"></div>'''OAuth2 authorization scopes''' (SCOPE)<BR>
-Specifies authorization scopes should be used with request. Used with *OAUTH2D, *OAUTH2C and *BRIDGE  authentification method
+Specifies authorization scopes should be used with request. Used with *OAUTH2D, *OAUTH2C and *BRIDGE  authorization method.
-<div id="BRIDGEURL"></div>'''i2Rest access flow bridge url''' (BRIDGEUR)<BR>
+<div id="BRIDGEURL"></div>'''i2Rest access flow bridge url''' (BRIDGEURL)<BR>
-Specify URI to be requested for OAuth2 client/device authorization.
+Specify URL to be used as redirection URI in Authorization Code flow.  Used with *BRIDGE authorization method.
 <div id="BRIDGEID"></div>'''i2Rest bridge client ID''' (BRIDGEID)<BR>
-Specify URI to be requested for a OAuth2 flow token. Used with *BRIDGE authentification method
+ID to be used authenticating i2rest Client with i2Rest Server in Authorization Code flow. Used with *BRIDGE authorization method.
 <div id="BRIDGEPW"></div>'''i2Rest bridge client passwd''' (BRIDGEPW)<BR>
-Specifies authorization scopes should be used with request. Used with *BRIDGE authentification method
+Password to be used authenticating i2rest Client with i2Rest Server in Authorization Code flow. Used with *BRIDGE authorization method.
 === Examples ===

@@ Line 78: / Line 78: @@
 |style="color: #8080FF; font-weight: bold;»|SCOPE ||	OAuth2 authorization scopes ||	Character value
 |-
-|style="color: #8080FF; font-weight: bold;»|AUTHURL || i2Rest access flow bridge url ||	Character value
+|style="color: #8080FF; font-weight: bold;»|BRIDGEURL || i2Rest access flow bridge url ||	Character value
 |-
-|style="color: #8080FF; font-weight: bold;»|TOKENURL || i2Rest bridge client ID ||	Character value
+|style="color: #8080FF; font-weight: bold;»|BRIDGEID || i2Rest bridge client ID ||	Character value
 |-
-|style="color: #8080FF; font-weight: bold;»|SCOPE || i2Rest bridge client password ||	Character value
+|style="color: #8080FF; font-weight: bold;»|BRIDGEPW|| i2Rest bridge client password ||	Character value
@@ Line 219: / Line 216: @@
 <div id="SCOPE"></div>'''OAuth2 authorization scopes''' (SCOPE)<BR>
 Specifies authorization scopes should be used with request. Used with *OAUTH2D, *OAUTH2C and *BRIDGE  authentification method

@@ Line 50: / Line 50: @@
 |style="color: #8080FF; font-weight: bold;»|SENTLOG || Log sent messages ||	Character value
 |-
-|style="color: #8080FF; font-weight: bold;»|AUTHMETHOD || Authentication method ||'''*OAUTH2D''', *OAUTH2C, *BASIC, *NONE
+|style="color: #8080FF; font-weight: bold;»|AUTHMETHOD || Authentication method ||'''*OAUTH2D''', *OAUTH2C, *BASIC, *NONE, *BRIDGE
 |-
 |style="color: #8080FF; font-weight: bold;»|TOKENS ||	Tokens storage ||	Character value
@@ Line 77: / Line 77: @@
 |-
 |style="color: #8080FF; font-weight: bold;»|SCOPE ||	OAuth2 authorization scopes ||	Character value
 |}
@@ Line 172: / Line 183: @@
 <div id="TOKENS"></div>'''Tokens storage''' (TOKENS)<BR>
-Path to token storage file. Either IFS or LIB file system approach (ex. - '/qsys.lib/qtemp.lib/tokens.usrspc') could be applied.
+Path to token storage file. Either IFS or LIB file system approach (ex. - '/qsys.lib/qtemp.lib/tokens.usrspc') could be applied. If
 <div id="REUSE"></div>'''Try to use saved token''' (REUSE)<BR>
@@ Line 208: / Line 219: @@
 <div id="SCOPE"></div>'''OAuth2 authorization scopes''' (SCOPE)<BR>
-Specifies authorization scopes should be used with request. Used with *OAUTH2D or *OAUTH2C authentification method
+Specifies authorization scopes should be used with request. Used with *OAUTH2D, *OAUTH2C and *BRIDGE  authentification method
 === Examples ===

@@ Line 213: / Line 213: @@
 '''Example 1 Device flow'''<BR>
 <pre>
-I2REST COMMAND(*POST) URL('http://192.168.0.233:8080') BODY(*N '{"command"
+I2REST COMMAND(*POST)
-:"STATUS"}' 'application/json' *YES 1208) OUTPUT(*BOTH) TOKENS('/qsys.lib/qtemp.
+       URL('http://192.168.0.233:8080')
-lib/tokens.usrspc') ASK(*REQUESTER) PROMPT(*REQUESTER) AUTHID(OAUTH21) AUTHPW(oa
+       BODY(*N '{"command":"STATUS"}'
-uth21) AUTHURL('http://i2rest.com:22088/oauth2/device') TOKENURL('http://i2rest.
+            'application/json' *YES 1208)
-com:22088/oauth2/access') SCOPE(manager_functions)
+       OUTPUT(*BOTH)
 </pre>