{
  "opencollection": "1.0.0",
  "info": {
    "name": "ThingsBoard Admin admin-controller o-auth-2-controller API",
    "version": "4.3.0.3DEMO"
  },
  "items": [
    {
      "info": {
        "name": "o-auth-2-controller",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Save OAuth2 Client (saveOAuth2Client)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/oauth2/client",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get OAuth2 Clients (getOAuth2Clients)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://demo.thingsboard.io/api/noauth/oauth2Clients",
            "params": [
              {
                "name": "pkgName",
                "value": "",
                "type": "query",
                "description": "Mobile application package name, to find OAuth2 clients where there is configured mobile application with such package name"
              },
              {
                "name": "platform",
                "value": "",
                "type": "query",
                "description": "Platform type to search OAuth2 clients for which the usage with this platform type is allowed in the settings. If platform type is not one of allowable values - it will just be ignored"
              }
            ]
          },
          "docs": "Get the list of OAuth2 clients to log in with, available for such domain scheme (HTTP or HTTPS) (if x-forwarded-proto request header is present - the scheme is known from it) and domain name and port (port may be known from x-forwarded-port header)"
        },
        {
          "info": {
            "name": "Get OAuth2 Log in Processing URL (getLoginProcessingUrl)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/oauth2/loginProcessingUrl"
          },
          "docs": "Returns the URL enclosed in double quotes. After successful authentication with OAuth2 provider, it makes a redirect to this path so that the platform can do further log in processing. This URL may be configured as 'security.oauth2.loginProcessingUrl' property in yml configuration file, or as 'SECURITY_OAUTH2_LOGIN_PROCESSING_URL' env variable. By default it is '/login/oauth2/code/'\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get OAuth2 Client by Id (getOAuth2ClientById)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/oauth2/client/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Delete Oauth2 Client (deleteOauth2Client)",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://demo.thingsboard.io/api/oauth2/client/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes the oauth2 client. Referencing non-existing oauth2 client Id will cause an error.\n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority."
        },
        {
          "info": {
            "name": "Get OAuth2 Client Infos by Ids (findTenantOAuth2ClientInfosByIds)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://demo.thingsboard.io/api/oauth2/client/infos",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Maximum amount of entities in a one page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Sequence number of page starting from 0"
              },
              {
                "name": "textSearch",
                "value": "",
                "type": "query",
                "description": "Case-insensitive 'substring' filter based on client's title"
              },
              {
                "name": "sortProperty",
                "value": "",
                "type": "query",
                "description": "Property of entity to sort by"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort order. ASC (ASCENDING) or DESC (DESCENDING)"
              },
              {
                "name": "clientIds",
                "value": "",
                "type": "query",
                "description": "A list of oauth2 ids, separated by comma ','"
              }
            ]
          },
          "docs": "Fetch OAuth2 Client info objects based on the provided ids. \n\nAvailable for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority."
        }
      ]
    }
  ],
  "bundled": true
}