Difference between revisions of "Management API config"
Pavel.lobko (talk | contribs) |
Pavel.lobko (talk | contribs) |
||
| Line 44: | Line 44: | ||
}</span> | }</span> | ||
} | } | ||
| − | + | ||
| − | + | Please take a look how to [[Auth_profile_SoapUI|obtain Oauth2 token with SoapUI]], and than proceed to [[Manage_API_SoapUI|Management api authorized call]]. | |
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 17:31, 29 June 2020
Management APIs includes functions that can be used to do some management stuff - change runtime parameters, query current status of server instance, etc. OAuth2 token with management_functions scope is required for any management Api call.
- 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.<bt>
Basic configuration management API variant (differences are highlighted in blue):
{
"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" : "*ANONYMOUS",
"submit" : "SBMJOB JOB(I2RESTA) \
USER(${user}) \
CMD(CALL I2REST \
PARM('-session' \
'-url' '${surl}' \
'-uid' '${uid}' \
'-user' '${user}')) \
INLLIBL(I2REST)"
}
],
"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"}
}
}
Please take a look how to obtain Oauth2 token with SoapUI, and than proceed to Management api authorized call.
