{
  "opencollection": "1.0.0",
  "info": {
    "name": "ThingsBoard Admin admin-controller API",
    "version": "4.3.0.3DEMO"
  },
  "items": [
    {
      "info": {
        "name": "admin-controller",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Creates or Updates the Administration Settings (saveAdminSettings)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/settings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or Updates the Administration Settings. Platform generates random Administration Settings Id during settings creation. The Administration Settings Id will be present in the response. Specify the Administration Settings Id when you would like to update the Administration Settings. Referencing non-existing Administration Settings Id will cause an error.\n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Send Test Sms (sendTestSms)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/settings/testSms",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Attempts to send test sms to the System Administrator User using SMS Settings and phone number provided as a parameters of the request. \n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Send Test Email (sendTestMail)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/settings/testMail",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Attempts to send test email to the System Administrator User using Mail Settings provided as a parameter. You may change the 'To' email in the user profile of the System Administrator. \n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get the Security Settings Object (getSecuritySettings)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/securitySettings"
          },
          "docs": "Get the Security Settings object that contains password policy, etc.\n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Update Security Settings (saveSecuritySettings)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/securitySettings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the Security Settings object that contains password policy, etc.\n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get Repository Settings (getRepositorySettings)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/repositorySettings"
          },
          "docs": "Get the repository settings object. \n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Creates or Updates the Repository Settings (saveRepositorySettings)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/repositorySettings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or Updates the repository settings object. \n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Delete Repository Settings (deleteRepositorySettings)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://demo.thingsboard.io/api/admin/repositorySettings"
          },
          "docs": "Deletes the repository settings.\n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Check Repository Access (checkRepositoryAccess)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/repositorySettings/checkAccess",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Attempts to check repository access. \n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get the JWT Settings Object (getJwtSettings)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/jwtSettings"
          },
          "docs": "Get the JWT Settings object that contains JWT token policy, etc. \n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Update JWT Settings (saveJwtSettings)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/jwtSettings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the JWT Settings object that contains JWT token policy, etc. The tokenSigningKey field is a Base64 encoded string.\n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get Auto Commit Settings (getAutoCommitSettings)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/autoCommitSettings"
          },
          "docs": "Get the auto commit settings object. \n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Creates or Updates the Auto Commit Settings (saveAutoCommitSettings)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/admin/autoCommitSettings",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates or Updates the auto commit settings object. \n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Delete Auto Commit Settings (deleteAutoCommitSettings)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://demo.thingsboard.io/api/admin/autoCommitSettings"
          },
          "docs": "Deletes the auto commit settings.\n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Check for New Platform Releases (checkUpdates)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/updates"
          },
          "docs": "Check notifications about new platform releases. \n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get System Info (getSystemInfo)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/systemInfo"
          },
          "docs": "Get main information about system. \n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get the Administration Settings Object Using Key (getAdminSettings)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/settings/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "A string value of the key (e.g. 'general' or 'mail')."
              }
            ]
          },
          "docs": "Get the Administration Settings object using specified string key. Referencing non-existing key will cause an error.\n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "getRepositorySettingsInfo",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/repositorySettings/info"
          }
        },
        {
          "info": {
            "name": "Check Repository Settings Exists (repositorySettingsExists)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/repositorySettings/exists"
          },
          "docs": "Check whether the repository settings exists. \n\nAvailable for users with 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get OAuth2 Log in Processing URL (getMailProcessingUrl)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/mail/oauth2/loginProcessingUrl"
          },
          "docs": "Returns the URL enclosed in double quotes. After successful authentication with OAuth2 provider and user consent for requested scope, it makes a redirect to this path so that the platform can do further log in processing and generating access tokens. \n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "codeProcessingUrl",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/mail/oauth2/code",
            "params": [
              {
                "name": "code",
                "value": "",
                "type": "query"
              },
              {
                "name": "state",
                "value": "",
                "type": "query"
              }
            ]
          }
        },
        {
          "info": {
            "name": "Redirect User to Mail Provider Login Page.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/mail/oauth2/authorize"
          },
          "docs": "After user logged in and provided accessprovider sends authorization code to specified redirect uri.)"
        },
        {
          "info": {
            "name": "Get Features Info (getFeaturesInfo)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/featuresInfo"
          },
          "docs": "Get information about enabled/disabled features. \n\nAvailable for users with 'SYS_ADMIN' authority."
        },
        {
          "info": {
            "name": "Check Auto Commit Settings Exists (autoCommitSettingsExists)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/admin/autoCommitSettings/exists"
          },
          "docs": "Check whether the auto commit settings exists. \n\nAvailable for users with 'TENANT_ADMIN' authority."
        }
      ]
    }
  ],
  "bundled": true
}