Difference between revisions of "I2Rest scopes"
(→management_functions) |
|||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{DISPLAYTITLE:i2Rest Scopes}} | ||
= i2Rest Scopes = | = i2Rest Scopes = | ||
| − | i2Rest Server uses following [https://oauth.net/2/scope | + | i2Rest Server uses following [https://oauth.net/2/scope OAuth2 scopes]: |
| − | * system_* | + | * <tt>system_*</tt> |
| − | * run_program | + | * <tt>run_program</tt> |
| − | * run_command | + | * <tt>run_command</tt> |
| − | * management_functions | + | * <tt>management_functions</tt> |
== system_* scope == | == system_* scope == | ||
| − | Use this scope during obtaining access token to specify particular [[i2Rest Gates#session_system|Session System]], for example system_S123456. All further calls to i2Rest APIs with this access token will be processed in Session job, started according settings of this Session System. Session System *LOCAL will be used to start Session job with access tokens that has no system_* in its scope. | + | Use this scope during obtaining access token to specify particular [[i2Rest Gates#session_system|Session System]], for example <tt>system_S123456</tt>. All further calls to i2Rest APIs with this access token will be processed in Session job, started according settings of this Session System. Session System <tt>*LOCAL</tt> will be used to start Session job with access tokens that has no <tt>system_*</tt> in its scope. |
== run_program == | == run_program == | ||
| − | This scope is optionally required to call [[i2Rest API# | + | This scope is optionally required to call [[i2Rest API#run_program_API|pcml-based]] API. Scope run_program is optional when <tt>"valid_in_anonymous":true</tt> is specified in [[pcml object]] definition. In other cases, it is required to include run_program in scope when requesting access token. |
== run_command == | == run_command == | ||
| − | This scope is required to call [[i2Rest API# | + | This scope is required to call [[i2Rest API#run_command_API|run_command API]] |
== management_functions == | == management_functions == | ||
| − | This scope is required to call [[i2Rest API# | + | This scope is required to call [[i2Rest API#Management_APIs|management APIs]] |
Latest revision as of 15:48, 8 April 2020
Contents
i2Rest Scopes
i2Rest Server uses following OAuth2 scopes:
- system_*
- run_program
- run_command
- management_functions
system_* scope
Use this scope during obtaining access token to specify particular Session System, for example system_S123456. All further calls to i2Rest APIs with this access token will be processed in Session job, started according settings of this Session System. Session System *LOCAL will be used to start Session job with access tokens that has no system_* in its scope.
run_program
This scope is optionally required to call pcml-based API. Scope run_program is optional when "valid_in_anonymous":true is specified in pcml object definition. In other cases, it is required to include run_program in scope when requesting access token.
run_command
This scope is required to call run_command API
management_functions
This scope is required to call management APIs
