i2Rest Scopes

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