UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 255 kB
{"openapi":"3.0.0","info":{"contact":{"email":"support@clearblade.com"},"description":"A friendly little API to help you interact with the ClearBlade platform.","termsOfService":"https://docs.clearblade.com/v/4/static/tac.html","title":"ClearBlade API","version":"3.0","x-apisguru-categories":["iot"],"x-origin":[{"format":"swagger","url":"https://docs.clearblade.com/v/4/static/api/openapi.yaml","version":"2.0"}],"x-providerName":"clearblade.com"},"tags":[{"description":"Adapter configuration and management.","name":"Adapter"},{"description":"Admin developer operations.","name":"Admin"},{"description":"Interactions for Two Factor Authentication.","name":"2FA"},{"description":"Interactions with the developer audit trail.","name":"Audit"},{"description":"Interactions with code services.","name":"Code"},{"description":"Interactions with webhooks.","name":"Webhooks"},{"description":"Interactions with data collections.","name":"Data"},{"description":"Interactions with external database connections.","name":"Databases"},{"description":"Deployment CRUD Operations","name":"Deployments"},{"description":"Device authentication and management.","name":"Device"},{"description":"Developer operations.","name":"Developer"},{"description":"Interactions with edges.","name":"Edge"},{"description":"Interactions triggers and timers.","name":"Handlers"},{"description":"MQTT messaging and push notifications.","name":"Messaging"},{"description":"Interactions with Shared Caches","name":"Shared Cache"},{"description":"User authentication and management.","name":"User"},{"description":"Interactions with user and device sessions.","name":"Session"},{"description":"Interactions with portals.","name":"Portal"},{"description":"Interactions with file management.","name":"Files"}],"paths":{"/admin/allapps":{"get":{"description":"Retrieves system information for all systems in the developer account.","operationId":"DevGetAssets","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns an array of system information."},"400":{"description":"Bad Request."}},"summary":"DEVELOPER - Get platform assets","tags":["Developer"]}},"/admin/allcollections":{"get":{"description":"Returns all the collections in the specified system.","operationId":"DevGetCollections","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System Key that identifies the system the collections belong to.","in":"query","name":"appid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of collections in the specified system."},"400":{"description":"Bad Request."}},"summary":"DEVELOPER - Get collections","tags":["Developer"]}},"/admin/allsystems":{"get":{"description":"Returns all the systems tied to the specified developer's account.","operationId":"GetSystems","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of systems."}},"summary":"DEVELOPER - Get systems","tags":["Developer"]}},"/admin/audit":{"get":{"description":"## Description:\nReturns list of assets and the information about the changes that have been made. This endpoint is for Admin only.\n### Query Structure:\n```json\n{\"PAGESIZE\":int,\"PAGENUM\":int,\"FILTERS\":[[{\"_REPLACE_WITH_OPERATOR_\":[{\"valueType\":\"value\"}]}]], \"SORT\":[{\"DESC\":\"value\"}]}\n```\n Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. \n## Audit Table Schema:\nRefer to this when building the query.\n\n | Column | Type | Possible Values|Example|\n |:---------|:---------|:------|:---------|\n | id | bigint |ANY_POSITIVE_INTEGER|10440595|\n |system_key|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|\"ccafb4cadaccaf9ebba01\"|\n |time|timestamp|ISO_DATE_TIME_STRING|\"2020-01-29T20:18:18.475214Z\"|\n |response_time|bigint|ANY_POSITIVE_INTEGER|4038669|\n |asset_class|string|adapters, adapterFiles, devices, users, multi_dev, services, libraries, servicecaches, timers, triggers, webhooks, portals, plugins, rolesperms, collections, edges, messaging, deployments, edgegroups, system, usersessions, devicesessions|\"collections\"|\n |action_type|string|Create, Update, Delete, Create Columns, Delete Columns, Developer Password Reset, User Password Reset, MQTT Disconnect, MQTT Connect|\"MQTT Connect\"|\n |email|string|SINGLE_VALID_EMAIL_STRING|\"example@clearblade.com\"|\n |asset_id|string|ANY_STRING|\"ClearBlade-iPhone\"|\n |changes|string|STRINGIFIED_JSON|\"{\\\\\"newVersion\\\\\":2}\"|\n |user_type|string|UNKNOWN, DEV, USER, DEVICE, Invalid UserType|\"DEVICE\"|\n \n### Example:\n\n```json\n{\"FILTERS\":[[{\"NEQ\":[{\"asset_class\":\"services\"}]},{\"EQ\":[{\"action_type\":\"create\"}]}]],\"PAGESIZE\":0,\"PAGENUM\":0}\n```\n","operationId":"GetAudit","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"Query object used to filter the items. See query model at in the description for example.","in":"query","name":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns audit information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/auditInfo"}}}}},"summary":"AUDIT - Get Audit Info","tags":["Audit"]}},"/admin/audit/count":{"get":{"description":"Gets total number of changes made to assets across all systems on the instance. This endpoint is Admin only.","operationId":"GetCounts","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns number of actions"}},"summary":"Audit - Get counts","tags":["Audit"]}},"/admin/audit/{systemKey}":{"get":{"description":"## Description:\nReturns list of assets and the information about the changes that have been made. This endpoint is for Admin and Dev.\n\n### Query Structure:\n```json\n{\"PAGESIZE\":int,\"PAGENUM\":int,\"FILTERS\":[[{\"_REPLACE_WITH_OPERATOR_\":[{\"valueType\":\"value\"}]}]], \"SORT\":[{\"DESC\":\"value\"}]}\n```\n Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. \n## Audit Table Schema:\nRefer to this when building the query.\n\n | Column | Type | Possible Values|Example|\n |:---------|:---------|:------|:---------|\n | id | bigint |ANY_POSITIVE_INTEGER|10440595|\n |system_key|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|\"ccafb4cadaccaf9ebba01\"|\n |time|timestamp|ISO_DATE_TIME_STRING|\"2020-01-29T20:18:18.475214Z\"|\n |response_time|bigint|ANY_POSITIVE_INTEGER|4038669|\n |asset_class|string|adapters, adapterFiles, devices, users, multi_dev, services, libraries, servicecaches, timers, triggers, webhooks, portals, plugins, rolesperms, collections, edges, messaging, deployments, edgegroups, system, usersessions, devicesessions|\"collections\"|\n |action_type|string|Create, Update, Delete, Create Columns, Delete Columns, Developer Password Reset, User Password Reset, MQTT Disconnect, MQTT Connect|\"MQTT Connect\"|\n |email|string|SINGLE_VALID_EMAIL_STRING|\"example@clearblade.com\"|\n |asset_id|string|ANY_STRING|\"ClearBlade-iPhone\"|\n |changes|string|STRINGIFIED_JSON|\"{\\\\\"newVersion\\\\\":2}\"|\n |user_type|string|UNKNOWN, DEV, USER, DEVICE, Invalid UserType|\"DEVICE\"|\n \n### Example:\n\n```json\n{\"FILTERS\":[[{\"NEQ\":[{\"asset_class\":\"services\"}]},{\"EQ\":[{\"action_type\":\"create\"}]}]],\"PAGESIZE\":0,\"PAGENUM\":0}\n```\n","operationId":"GetAuditDev","parameters":[{"description":"System Key that identifies the system that holds the deployment.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"Query object used to filter the items. See query model at in the description for example.","in":"query","name":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns audit information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/auditInfo"}}}}},"summary":"AUDIT - Get Audit Info","tags":["Audit"]}},"/admin/audit/{systemKey}/count":{"get":{"description":"Gets total number of changes made to assets across all systems on the instance. This endpoint is for Admin and Dev.","operationId":"GetCountsDev","parameters":[{"description":"System Key that identifies the system that holds the deployment.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns number of actions"}},"summary":"AUDIT - Get counts","tags":["Audit"]}},"/admin/auth":{"post":{"description":"## Description\nLogs developer into system and returns an Developer Token\n## Endpoint Body Values\nHere are the body values for the two scenarios\n### Basic Auth\nRequired Keys\n - username\n - password\n\nExample \n```json\n{\n \"username\":\"cbman@clearblade.com\",\n \"password\":\"cl34rbl4d3\"\n}\n``` \n\n### Refreshing Token\nRequired Keys \n - grant_type (only one valid value - \"refresh_token\")\n - refresh_token\n - access_token\n\nExample \n```json\n{\n \"grant_type\":\"refresh_token\",\n \"refresh_token\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiJmMjkwZTJlYjBiZDRmNjhiZDRkM2RlZjNkMWM0MDEiLCJzaWQiOiIzOWFkM2U5OC1hMmU0LTQxYzQtOGMzNi03ZjQxNDFhYzYxN2IiLCJ1dCI6MiwidHQiOjMsImV4cCI6MTU5MDI3ODExMSwiaWF0IjoxNTg5NDE0MTExfQ.iY6uJu2QgNP0uHoGdmEZm9wsztB1SUrCHrisxoXoxolol\",\n \"access_token\":\"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiJmMjkwZTJlYjBiZDRmNjhiZDRkM2RlZjNkMWM0MDEiLCJzaWQiOiI3NmY4ODg4MS04YmU5LTRiM2UtOWJkNi1jOTJjZGQ4OTNlMmEiLCJ1dCI6MiwidHQiOjEsImV4cCI6MTU4OTg0NjExMSwiaWF0IjoxNTg5NDE0MTExfQ.xboryHuVn2zz-gSZ_JcD7-j_eBmJU1SMHkiDl9j8bak\"\n}\n```\n","operationId":"AuthDev","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/authdata"}}},"description":"Developer credentials.","required":true},"responses":{"200":{"description":"Developer authenticated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/devregresp"}}}}},"summary":"DEVELOPER - Authenticate dev","tags":["Developer"]}},"/admin/checkauth":{"post":{"description":"Verifies developer access to the system","operationId":"VerifyAuth","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Receives access to the system."},"400":{"description":"Bad Request."}},"summary":"DEVELOPER - Verifies access to the system","tags":["Developer"]}},"/admin/collectionmanagement":{"delete":{"description":"Deletes an existing collection in the specified system.","operationId":"DevDeleteCollection","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"ID that identifies the collection to be deleted.","in":"query","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Collection was successfully deleted."}},"summary":"DEVELOPER - Delete collection","tags":["Developer"]},"post":{"description":"Creates a new collection or database connection in the specified system.","operationId":"DevCreateCollection","parameters":[{"description":"Developer Token obtained through authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/newcollection"},"responses":{"200":{"description":"Collection was successfully created."}},"summary":"DEVELOPER - Create collection","tags":["Developer"]},"put":{"description":"Creates or deletes a column within an existing collection, or updates an existing database connection in the specified system.","operationId":"DevUpdateCollection","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":false,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/updateCollection"},"responses":{"200":{"description":"Collection was successfully updated."}},"summary":"DEVELOPER - Update collection","tags":["Developer"]}},"/admin/count/developers":{"get":{"description":"Retrieves the number of developers who are considered administrators in their system.","operationId":"GetAdminDevCount","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns number of admin developers"},"400":{"description":"Bad request."}},"summary":"ADMIN - Get number of admin developers","tags":["Admin"]}},"/admin/count/systems":{"get":{"description":"Retrieves the number of systems that are available.","operationId":"GetSystemCount","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"},"400":{"description":"Bad request."},"404":{"description":"Not Found"}},"summary":"ADMIN - Get number of systems available","tags":["Admin"]}},"/admin/database/status":{"get":{"description":"Returns all the names and internal and external database statuses","operationId":"GetDatabaseStatus","responses":{"200":{"description":"## Description:\n Returns all the names and internal and external database statuses in a system\n ### Success Structure:\n ```json\n {\n [IP_ADDRESS]\": {\n \"internal_db_stats\": {\n \"name\": \"Postgres\",\n \"stats\": {\n \"db_type\": \"PostgreSQL\",\n \"info\": {\n \"Idle\": 2,\n \"InUse\": 0,\n \"MaxIdleClosed\": 55380,\n \"MaxIdleTimeClosed\": 0,\n \"MaxLifetimeClosed\": 0,\n \"MaxOpenConnections\": 30,\n \"OpenConnections\": 2,\n \"WaitCount\": 0,\n \"WaitDuration\": 0\n },\n \"is_connected\": true\n }\n },\n \"external_db_stats\": {}\n ```\n |\n"}},"summary":"DATABASES - Retrieves all internal and external database statuses","tags":["Databases"]}},"/admin/developers/{systemKey}":{"put":{"description":"For admin, you can add/remove/change the owner of a system even if you’re not the system's owner. For Developer,you can add/remove a developer as long as you’re the owner of the system.","operationId":"AdminOwnerChange","parameters":[{"description":"System Key that identifies the system that holds the deployment.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateOwner"}}},"description":"Updated system owner email."},"responses":{"200":{"description":"Owner successfully added/removed."},"400":{"description":"Bad Request."},"500":{"description":"Internal Server Error."}},"summary":"ADMIN - Add/Remove/Change owner","tags":["Admin","Developer"]}},"/admin/devices/keys/{systemKey}/{deviceName}":{"delete":{"description":"Deletes the rotating keys from its device.","operationId":"DeleteDeviceKeys","parameters":[{"description":"Developer Token obtained through developer authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the device currently belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the device whose keys are being deleted.","in":"path","name":"deviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deletes rotating keys"}},"summary":"DEVELOPER - Delete rotating keys for a device","tags":["Developer"]},"post":{"description":"Creates rotating keys for a device.","operationId":"CreateRotatingKeys","parameters":[{"description":"Developer Token obtained through developer authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the device you're updating belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the device you are adding keys to .","in":"path","name":"deviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/count"}}},"description":"Number of rotating keys.","required":true},"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deviceKey"}}}}},"summary":"DEVICE -Creates rotating keys for a device.","tags":["Device"]}},"/admin/devices/{systemKey}":{"delete":{"description":"Deletes all devices matching the filters specified by a query.","operationId":"DeleteDevicesAdmin","parameters":[{"description":"System Key that identifies the system the device is a part of.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Token obtained through user authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"Tags to filter devices by. See the query model below for an example.","in":"query","name":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted devices."},"400":{"description":"Bad request."}},"summary":"DEVELOPER - Delete devices using a query","tags":["Developer"]},"get":{"description":"Retrieves information about all devices in the specified system","operationId":"GetSystemDevices","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the devices in question belong to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Tags to filter devices by. See the query model below for an example. All devices are returned if a query is not specified.","in":"query","name":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of devices."},"400":{"description":"Bad request."}},"summary":"DEVELOPER - Get devices with or without a query","tags":["Developer"]},"put":{"description":"Updates all devices matching the filters specified by a query.","operationId":"UpdateDevicesAdmin","parameters":[{"description":"System Key that identifies the system the device is a part of.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Token obtained through user authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/PutQuery"},"responses":{"200":{"description":"A JSON object representing the SQL result set containing the list of affected devices.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryResultSet"}}}},"400":{"description":"Bad request."}},"summary":"DEVELOPER - Update devices using a query","tags":["Developer"]}},"/admin/devices/{systemKey}/{name}":{"delete":{"description":"Deletes the specified device from its system.","operationId":"DeleteSystemDevice","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the device currently belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the device you're deleting.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Delete device","tags":["Developer"]},"get":{"description":"Retrieves information about the specified device.","operationId":"GetSystemDevice","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the device in question belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the device you're getting info about.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Get device","tags":["Developer"]},"post":{"description":"Creates a new device in the specified system.","operationId":"CreateSystemDevice","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the new device will belong to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the device you're creating.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deviceAdminNew"}}},"description":"New device information.","required":true},"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Create device","tags":["Developer"]},"put":{"description":"Updates the specified device's information.","operationId":"UpdateSystemDevice","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the device you're updating belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the device you're updating.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deviceAdminUpdate"}}},"description":"Updated device information.","required":true},"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Update device","tags":["Developer"]}},"/admin/edges/template/{systemKey}":{"get":{"description":"Get list of which triggers, services, and libraries should be copied onto which edge when it starts up.","operationId":"GetEdgeTemplate","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the edge template belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Get edge template","tags":["Developer"]}},"/admin/edges/template/{systemKey}/{edgeName}":{"put":{"description":"Update template for the specified edge.","operationId":"UpdateEdgeTemplate","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the edge template belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the edge you're modifying the template for.","in":"path","name":"edgeName","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/edgeTemplateUpdate"}}},"description":"list of resources to add or remove to the template for an edge.","required":true},"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Update edge template","tags":["Developer"]}},"/admin/edges/{systemKey}":{"get":{"description":"Retrieves all the edges that belong to the specified system.","operationId":"GetEdges","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the edges in question belong to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Get edges","tags":["Developer"]}},"/admin/edges/{systemKey}/control":{"get":{"description":"Retrieves all the edges that the adapter belongs to.","operationId":"GetAdapterEdges","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the edges in question belong to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Get edges for the adapter","tags":["Developer"]}},"/admin/edges/{systemKey}/{edgeName}":{"delete":{"description":"Deletes the specified edge from its system.","operationId":"DeleteEdge","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the edge currently belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the edge you're deleting.","in":"path","name":"edgeName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Delete edge","tags":["Developer"]},"get":{"description":"Retrieves information about the specified edge.","operationId":"GetEdge","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the edge in question belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the edge you're getting info about.","in":"path","name":"edgeName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Get edge","tags":["Developer"]},"post":{"description":"Creates a new edge in the specified system.","operationId":"CreateEdge","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the new edge will belong to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the edge you're creating.","in":"path","name":"edgeName","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/edgeNew"},"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Create edge","tags":["Developer"]},"put":{"description":"Updates the specified edge's information.","operationId":"UpdateEdge","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System key that identifies the system the edge you're updating belongs to.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Name of the edge you're updating.","in":"path","name":"edgeName","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/edgeUpdate"},"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Update edge","tags":["Developer"]}},"/admin/logout":{"post":{"description":"Logs the current developer out of their session and invalidates their DevToken","operationId":"DevLogout","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Developer was successfully logged out."}},"summary":"DEVELOPER - Log out dev","tags":["Developer"]}},"/admin/pkey":{"get":{"description":"Returns current platform license key.","operationId":"GetLicenseKey","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns platform license key"},"400":{"description":"Bad Request"}},"summary":"ADMIN - Get platform license key.","tags":["Admin"]}},"/admin/platform/developer":{"get":{"description":"Returns information about the specified developer.","operationId":"GetDev","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"Email of the developer in question.","in":"query","name":"developer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"ADMIN - Get developer","tags":["Admin"]},"post":{"description":"Disables the specified developer on the platform.","operationId":"DisableDev","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disableData"}}},"description":"Information to identify the developer you're disabling.","required":true},"responses":{"200":{"description":"No response was specified"}},"summary":"DEVELOPER - Disable developer","tags":["Developer"]}},"/admin/platform/developers":{"get":{"description":"Returns all developers in the platform.","operationId":"GetDevs","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"Response page size.","in":"query","name":"pagesize","required":false,"schema":{"type":"string"}},{"description":"Response page number.","in":"query","name":"pagenum","required":false,"schema":{"type":"string"}},{"description":"","in":"query","name":"total","required":false,"schema":{"type":"string"}},{"description":"Filter response.","in":"query","name":"filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"ADMIN - Get developers","tags":["Admin"]}},"/admin/platform/systems":{"get":{"description":"## Description:\nGet list of systems that have been updated. This is an Admin only endpoint.\n\n### Query:\n```json\n{\"PAGESIZE\":int,\"PAGENUM\":int,\"FILTERS\":[[{\"_REPLACE_WITH_OPERATOR_\":[{\"valueType\":\"value\"}]}]],\"SORT\":[{\"DESC\":\"value\"}]}\n```\n Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. \n## Admin Audit Table Schema:\nRefer to this when building the query.\n\n | Column | Type | Possible Values| Examples|\n |:--------|:--------|:------|:------|\n | name | string |ANY_STRING|\"ClearBladeDev\"|\n |owner|string|EMAIL_STRING |\"example@clearblade.com\"|\n |systemKey|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|\"80sdff82c0b1fbda1f271\"|\n |disabled|boolean|true, false|true|\n |lastUpdated|timestamp|ISO_DATE_TIME_STRING|\"2020-01-29T20:18:18.475214Z\"|\n |numDevs|int|ANY_POSITIVE_INTEGER|2|\n |numServices|int|ANY_POSITIVE_INTEGER|2|\n |numLibraries|int|ANY_POSITIVE_INTEGER|2|\n |numDeployments|int|ANY_POSITIVE_INTEGER|2|\n |numRoles|int|ANY_POSITIVE_INTEGER|2|\n |numUsers|int|ANY_POSITIVE_INTEGER|2|\n |numDevices|int|ANY_POSITIVE_INTEGER|2|\n |numEdge|int|ANY_POSITIVE_INTEGER|2|\n |numAPIReqsTotal|int|ANY_POSITIVE_INTEGER|2|\n |numAPIReqsMonth|int|ANY_POSITIVE_INTEGER|2|\n |numAPIReqsYear|int|ANY_POSITIVE_INTEGER|2|\n |numPub|int|ANY_POSITIVE_INTEGER|2|\n |numPubMonth|int|ANY_POSITIVE_INTEGER|2|\n |numPubYear|int|ANY_POSITIVE_INTEGER|2|\n |numRecTotal|int|ANY_POSITIVE_INTEGER|2|\n |numRecMonth|int|ANY_POSITIVE_INTEGER|2|\n |numRecYear|int|ANY_POSITIVE_INTEGER|2|\n |diskUsage|int|ANY_POSITIVE_INTEGER|2|\n\n### Example:\n\n```json\n \"query\":{\"FILTERS\":[[{\"NEQ\":[{\"disabled\":true}]},{\"EQ\":[{\"numDevs\":2}]}]],\"PAGESIZE\":0,\"PAGENUM\":0}\n```\n","operationId":"GetSystemUpdates","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"Clearblade-DevToken","required":true,"schema":{"type":"string"}},{"description":"Query object used to filter the items. See query model at in the description for example.","in":"query","name":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/systemInfo"}}}}},"summary":"AUDIT - Get list of systems that have been updated","tags":["Audit"]}},"/admin/platform/systems/{systemKey}":{"get":{"description":"## Description:\n Get list of changes that have been made to the system. This is an Admin and Dev endpoint.\n### Query:\n```json\n\"query\":{\"PAGESIZE\":int,\"PAGENUM\":int,\"FILTERS\":[[{\"_REPLACE_WITH_OPERATOR_\":[{\"valueType\":\"value\"}]}]],\"SORT\":[{\"DESC\":\"value\"}]}\n```\n Note - You can generate a complex query object in a code service using the `ClearBlade.Query()` object. \n## Admin Audit Table Schema:\n## Admin Audit Table Schema:\nRefer to this when building the query.\n\n | Column | Type | Possible Values| Examples|\n |:--------|:--------|:------|:------|\n | name | string |ANY_STRING|\"ClearBladeDev\"|\n |owner|string|EMAIL_STRING |\"example@clearblade.com\"|\n |systemKey|string|SINGLE_STRING_WITH_HEX_CHARS_ONLY|\"80sdff82c0b1fbda1f271\"|\n |disabled|boolean|true, false|true|\n |lastUpdated|timestamp|ISO_DATE_TIME_STRING|\"2020-01-29T20:18:18.475214Z\"|\n |numDevs|int|ANY_POSITIVE_INTEGER|2|\n |numServices|int|ANY_POSITIVE_INTEGER|2|\n |numLibraries|int|ANY_POSITIVE_INTEGER|2|\n |numDeployments|int|ANY_POSITIVE_INTEGER|2|\n |numRoles|int|ANY_POSITIVE_INTEGER|2|\n |numUsers|int|ANY_POSITIVE_INTEGER|2|\n |numDevices|int|ANY_POSITIVE_INTEGER|2|\n |numEdge|int|ANY_POSITIVE_INTEGER|2|\n |numAPIReqsTotal|int|ANY_POSITIVE_INTEGER|2|\n |numAPIReqsMonth|int|ANY_POSITIVE_INTEGER|2|\n |numAPIReqsYear|int|ANY_POSITIVE_INTEGER|2|\n |numPub|int|ANY_POSITIVE_INTEGER|2|\n |numPubMonth|int|ANY_POSITIVE_INTEGER|2|\n |numPubYear|int|ANY_POSITIVE_INTEGER|2|\n |numRecTotal|int|ANY_POSITIVE_INTEGER|2|\n |numRecMonth|int|ANY_POSITIVE_INTEGER|2|\n |numRecYear|int|ANY_POSITIVE_INTEGER|2|\n |diskUsage|int|ANY_POSITIVE_INTEGER|2|\n\n### Example:\n\n```json\n \"query\":{\"FILTERS\":[[{\"NEQ\":[{\"disabled\":true}]},{\"EQ\":[{\"numDevs\":2}]}]],\"PAGESIZE\":0,\"PAGENUM\":0}\n```\n","operationId":"GetSystemUpdatesDev","parameters":[{"description":"System Key that identifies the system that holds the deployment.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}},{"description":"Developer Token obtained through admin authentication.","in":"header","name":"clearblade-devtoken","required":true,"schema":{"type":"string"}},{"description":"Query object used to filter the items. See query model at in the description for example.","in":"query","name":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/systemInfo"}}}}},"summary":"AUDIT - Get list of systems that have been updated","tags":["Audit"]}},"/admin/platform/{systemKey}":{"get":{"description":"Retrieves the specified system's status as it relates to limits. To be used by the billing system.","operationId":"GetSystemStatus","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System Key that identifies the system you're requesting information about.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified"}},"summary":"ADMIN - Get system status","tags":["Admin"]}},"/admin/portals/{systemKey}":{"get":{"description":"Returns information about a specified portal.","operationId":"GetPortalInfo","parameters":[{"description":"Developer Token obtained through developer authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}},{"description":"System Key that identifies the specified system.","in":"path","name":"systemKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"No response was specified","content":{"application/json":{"schema":{"$ref":"#/components/schemas/portalArray"}}}}},"summary":"DEVELOPER - Gets the information for a portal","tags":["Developer"]}},"/admin/putpass":{"put":{"description":"Changes a developer's password.","operationId":"ChangeDevPassword","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devpass"}}},"description":"Password change information.","required":true},"responses":{"200":{"description":"Developer's password was successfully changed."}},"summary":"DEVELOPER - Change dev password","tags":["Developer"]}},"/admin/reg":{"post":{"description":"Registers a new developer account with the CB platform.","operationId":"RegDev","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devregdata"}}},"description":"First and last name, organization, email, and password for developer","required":true},"responses":{"200":{"description":"Developer was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/devregresp"}}}},"500":{"description":"Internal Server Error."}},"summary":"DEVELOPER - Register new dev","tags":["Developer"]}},"/admin/regensystemsecret":{"put":{"description":"Generates a new System Secret for the specified system.","operationId":"RegenSecret","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/regensystem"}}},"description":"System Key that identifies the system you're regenerating the secret for.","required":true},"responses":{"200":{"description":"New System Secret was successfully generated."}},"summary":"DEVELOPER - Regen secret","tags":["Developer"]}},"/admin/resetpassword":{"post":{"description":"Changes a developer's password.","operationId":"ResetPassword","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resetPassword"}}},"description":"New login information.","required":true},"responses":{"200":{"description":"Password is resetted"}},"summary":"ADMIN - Change dev password (Admin)","tags":["Admin"]}},"/admin/settings/email-service":{"delete":{"description":"Deletes email communication settings. This endpoint is Admin only.","operationId":"DeleteEmailSettings","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Email settings was successfully deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResp"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Delete email settings","tags":["2FA"]},"get":{"description":"Gets current email communication settings. This endpoint is Admin only.","operationId":"EmailSettings","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns email communcation settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailSettings"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Get Email Settings","tags":["2FA"]},"post":{"description":"## Description:\n Creates email communication . This endpoint is Admin only.\n \n## Settings choices\n\n|Settings|Allowed Values|\n|--------|-----|\n|encryption_type|STARTTLS, TLS, NONE|\n|protocol|SMTP|\n","operationId":"CreateEmailCommunication","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/emailSettings"},"responses":{"200":{"description":"Successfully added email service settings"},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Create Email Communication","tags":["2FA"]},"put":{"description":"\n## Description:\nUpdates email communication settings. This endpoint is Admin only.\n \n## Setting options\n \n|Settings|Types|\n|--------|-----|\n|encryption_type|STARTTLS, TLS, NONE|\n|port|25, 465, 587, 2525|\n\nSMTP is the only protocol supported\n","operationId":"UpdateEmailSettings","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/emailSettings"},"responses":{"200":{"description":"Successfully updated email service settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResp"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Update Email Settings","tags":["2FA"]}},"/admin/settings/email-service/test":{"post":{"description":"Test email service . This endpoint is Admin only.","operationId":"TestEmail","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailTest"}}},"description":"The recipient email address to send the test message","required":true},"responses":{"200":{"description":"Successfully sends test email","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResp"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Test Email Service","tags":["2FA"]}},"/admin/settings/security":{"get":{"description":"View instance wide security settings. This endpoint is Admin only.","operationId":"ViewSecurity","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns 2FA security settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettings"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - View Security Settings","tags":["2FA"]},"put":{"description":"Update instance wide security settings.TTL must be between 86400 and 2592000 seconds. This endpoint is Admin only.","operationId":"UpdateSecurity","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettings"}}},"description":"The SMS settings to be updated","required":true},"responses":{"200":{"description":"Successfully updated 2FA security settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecuritySettings"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Update Security Settings","tags":["2FA"]}},"/admin/settings/sms-service":{"delete":{"description":"Deletes SMS communication settings. This endpoint is Admin only.","operationId":"DeleteSMSSettings","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SMS settings was successfully deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResp"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Delete SMS settings","tags":["2FA"]},"get":{"description":"Gets current SMS communication settings. This endpoint is Admin only.","operationId":"SMSSettings","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns SMS communcation settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SMSSettings"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Get SMS Settings","tags":["2FA"]},"post":{"description":"Creates SMS communication . Twilio is the only supported service. This endpoint is Admin only.","operationId":"CreateSMSCommunication","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/SMSSettings"},"responses":{"200":{"description":"Successfully added SMS service settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResp"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Create SMS Communication","tags":["2FA"]},"put":{"description":"Updates SMS communication settings. Twilio is the only supported service. This endpoint is Admin only.","operationId":"UpdateSMSSettings","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/SMSSettings"},"responses":{"200":{"description":"Successfully updated SMS service settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResp"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Update SMS Settings","tags":["2FA"]}},"/admin/settings/sms-service/test":{"post":{"description":"Test SMS service . This endpoint is Admin only.","operationId":"TestSMS","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"header","name":"ClearBlade-DevToken","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SMSTest"}}},"description":"The recipient phone number to send the test message","required":true},"responses":{"200":{"description":"Successfully sends test message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResp"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResp"}}}}},"summary":"2FA - Test SMS Service","tags":["2FA"]}},"/admin/systems/{devEmail}":{"get":{"description":"Get the list of systems the developer has access to","operationId":"GetSystemsForDev","parameters":[{"description":"Developer Token obtained through admin authentication.","in":"hea