Api.getpermissions - Siemens SIMATIC S7-1500 Function Manual

Possible error messages
The following table shows the possible error messages of the Api.Login method.
Error code Error message
100 Login failed
101 Already authenticated
4 No resources
3.20.2.2

Api.GetPermissions

After the successful login, the Api.GetPermissions returns a list of actions for whose
execution the user is authorized.
Example
The following example shows the actions for which the user is authorized.
[
{ "name": "read_value" },
{ "name": "change_operating_mode" }
]
Checkable authorizations
You can use the Web API to check the authorizations for the following actions.
Action
read_diagnostics
read_value
write_value
acknowledge_alarms
firmware_update
open_user_pages
read_file
write_file
change_operating_mode
flash_leds
backup_plc
restore_plc
failsafe_admin
The Web API checks the authorization on the basis of the rights and passwords assigned in
STEP 7 in the area "Web server > User administration".
A description of the user management can be found in section "Configuring the Web server
(Page 19)".
Web server
Function Manual, 11/2019, A5E03484625-AG
Meaning
The user name and/or password are not valid. Assign a reliable user name and
password.
The current X-Auth token is already authenticated. Use Api.Logout before you
authenticate yourself again.
The system does not have the required resources to carry out this request.
Carry out the request again as soon as sufficient resources are available again.
User authorization
Querying diagnostic data from the CPU without being permitted to change data
Read process data from the CPU
Write process data to the CPU
Acknowledge alarms
Install firmware updates on the CPU, central and distributed I/O modules
Call user-defined pages on the CPU
Reading the contents of files on the CPU
Changing the contents of files and folders on the CPU
Changing the operating state
Request identification of the device
Backing up the CPU configuration
Restore configuration of the CPU
Make fail-safe changes on the CPU
3.20 API (Application Programming Interface)
Web pages
163