Difference between revisions of "Session system object"

From i2Rest
Jump to: navigation, search
(Created page with "= Session System Object = Object representing session system settings Do not forget to define system_* scope for Ses...")
 
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
= Session System Object =
+
{{DISPLAYTITLE:Session System Object}}
−
 
 
 
Object representing [[i2Rest Gates#session_system|session system]] settings
 
Object representing [[i2Rest Gates#session_system|session system]] settings
  
Line 15: Line 14:
 
|style="padding: 5px"|'''REQUIRED, Name of the system'''
 
|style="padding: 5px"|'''REQUIRED, Name of the system'''
 
Name to be used as an identity for this session system. To call APIs with this system settings, clients will have to obtain authority with special [[i2Rest scopes|scope]] <tt>system_<nowiki><system_name></nowiki></tt>. This scope is not required when calling for APIs on systems with special names:<br/>
 
Name to be used as an identity for this session system. To call APIs with this system settings, clients will have to obtain authority with special [[i2Rest scopes|scope]] <tt>system_<nowiki><system_name></nowiki></tt>. This scope is not required when calling for APIs on systems with special names:<br/>
 +
|
 
{|
 
{|
 
|-style="vertical-align:top;"
 
|-style="vertical-align:top;"
Line 45: Line 45:
 
|style="padding: 5px"|<tt>${anonymous}</tt>
 
|style="padding: 5px"|<tt>${anonymous}</tt>
 
|style="padding: 5px"|Y for anonymous sessions, N for others
 
|style="padding: 5px"|Y for anonymous sessions, N for others
 +
|-style="vertical-align:top;"
 +
|style="padding: 5px"|<tt>${scopes}</tt>
 +
|style="padding: 5px"|List of scopes used to used to create the token
 
|}
 
|}
 
Examples:
 
Examples:
Line 54: Line 57:
 
             '-uid' '${uid}'
 
             '-uid' '${uid}'
 
             '-user' '${user}'
 
             '-user' '${user}'
 +
            '-swap_to_user'
 +
            '-scopes' '${scopes}'
 
             '-init' 'ADDLIBLE MYLIB'))
 
             '-init' 'ADDLIBLE MYLIB'))
 
       INLLIBL(LIBX LIBY)
 
       INLLIBL(LIBX LIBY)
Line 68: Line 73:
 
|style="padding: 5px"|boolean
 
|style="padding: 5px"|boolean
 
|style="padding: 5px"|'''Non-IBMi system?'''
 
|style="padding: 5px"|'''Non-IBMi system?'''
−
For IBMi systems, you have to prepare special "submit" command and session processor program. Submit command should be able to start session processor task on remote non-IBMi system.<br/><br/>
+
For IBMi systems, you have to prepare special "submit" command and session processing program. Submit command should be able to start session processor task on remote non-IBMi system.<br/><br/>
−
Please [[contact i2Rest support]] for additional information
+
Please [mailto:contacts@i2rest.com contact us] for additional information
 
|style="padding: 5px"|<tt>false</tt>
 
|style="padding: 5px"|<tt>false</tt>
 
|}
 
|}

Latest revision as of 14:31, 17 June 2020

Object representing session system settings

Do not forget to define system_* scope for Session Systems with names other than *ANONYMOUS and *LOCAL

Field Type Description Default value
name string REQUIRED, Name of the system

Name to be used as an identity for this session system. To call APIs with this system settings, clients will have to obtain authority with special scope system_<system_name>. This scope is not required when calling for APIs on systems with special names:
*LOCAL corresponds to this IBM i server
*ANONYMOUS for that API which is allowed to call without user/client authorization
submit string
REQUIRED, Command to submit session

Specifies command to be used on submitting job which will process client's requests. Typically, it would be one of: SBMJOB or SBMRMTCMD. But i2Rest does not limit to use external non-IBMi systems which will act as session processor.
To be more flexible in terms of defining submitted job characteristics, i2Rest will substitute following substrings with appropriate values:

${uid} session ID (value of OAuth2 access token or automatically generated ID of anonymous session)
${surl} session gate URL
${user} user ID
${token} OAuth2 token value
${anonymous} Y for anonymous sessions, N for others
${scopes} List of scopes used to used to create the token

Examples: 

SBMJOB JOB(I2RESTS) USER(${user})
       CMD(CALL I2REST PARM(
             '-session'
             '-url' '${surl}'
             '-uid' '${uid}'
             '-user' '${user}'
             '-swap_to_user'
             '-scopes' '${scopes}'
             '-init' 'ADDLIBLE MYLIB'))
       INLLIBL(LIBX LIBY)

SBMRMTCMD DDMFILE(QGPL/RMTSYS)
       CMD('SBMJOB CMD(CALL I2REST PARM(''-session''
          ''-url'' ''${surl}''
          ''-uid'' ''${uid}''))')

See also i2Rest -session

non_ibmi boolean Non-IBMi system?

For IBMi systems, you have to prepare special "submit" command and session processing program. Submit command should be able to start session processor task on remote non-IBMi system.

Please contact us for additional information

false
Retrieved from "https://www.i2rest.com/index.php?title=Session_system_object&oldid=1264"