Authorizations
Updated:
Permissions: account:read, account:write
list_auth
🟢 read-only · account:read
All authorizations: login/password pairs and whitelisted IPs, with ids and active state. password comes back masked unless you ask for it.
Parameter | Type | Description |
|---|---|---|
| boolean | Return |
add_auth
🟡 changes account state · account:write
Create an authorization. Without ip — login/password generated by the system (change them later with change_auth). With ip — IP whitelist.
Parameter | Type | Description |
|---|---|---|
| string | The order the authorization belongs to ( |
| string | IP to whitelist |
change_auth
🟡 changes account state · account:write
Change an authorization: enable or disable it, change the login/password of a login authorization or the IP of an IP authorization. Send only what changes. An IP authorization can be changed only together with a new ip, including enabling or disabling it — to revoke access by IP, delete the authorization with delete_auth.
Parameter | Type | Description |
|---|---|---|
| string | integer | From list_auth |
| string | New login of a login authorization |
| string | New password of a login authorization |
| string | New IP of an IP authorization: public IPv4, different from the current one. Required to change an IP authorization, even to only enable or disable it |
| boolean | Enable / disable. For an IP authorization only together with a new |
delete_auth
🔴 destructive · account:write
Delete an authorization. Connections using it stop working. This is the only way to revoke access by IP: an IP authorization cannot be disabled without a new ip.
Parameter | Type | Description |
|---|---|---|
| string | integer | From list_auth |