{"items":[{"type":"link","label":"ESPER API REFERENCE","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"ESPER API REFERENCE"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"developer@esper.io","label":"developer@esper.io","withCopyButton":true,"copyContent":"developer@esper.io"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://esper.io/terms-of-service"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop","description":"Custom end point"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"ESPER API REFERENCE (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to Esper’s API documentation. The Esper API allows users to accomplish operations outside of the console. Some common uses for our APIs include observing device information and console activity, installing and updating apps, uploading files, and sending files to devices. Our users have also used the API to automate app updates, perform bulk actions, and more."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Esper API endpoints use REST-based architecture and return JSON responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See our documentation for:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/14199291792145-Getting-Started-with-APIs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting started guides"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/16036992814609-Commonly-Used-APIs"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commonly used API examples"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/16693582666769-Scheduling-API-Commands"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API command examples"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/22957898441745-Automating-App-Updates-Using-the-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automated Script examples"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/sections/11388094627857-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"And more"},"children":[]}]}]}]}]}]}],"sectionId":"/openapi/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to create an API Key to interact with our APIs. Learn more about generating an API Key. You can also learn more about Esper and sign up for an account at esper.io/signup."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some endpoints also require an Enterprise ID. This ID can be found in the API Management section of the Esper console."},"children":[]}]}]}]}],"sectionId":"/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses may be paginated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the following parameters to query the data. A full list of parameters can be found on the endpoint’s documentation page."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Parameter"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Data Type"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Explanation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"limit"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"integer"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Limit the data returned. Default = 20."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"offset"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"integer"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Offset to the first item returned. Default = 0."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ordering"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"string"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Order the results set by the field name. Varies by endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"next"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"string"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Paginate to the next response set."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"previous"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"string"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Paginate to the last set response."},"children":[]}]}]}]}]}]}],"sectionId":"/openapi/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We use standard HTTP status codes for success or failure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A typical error response may look something like this:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"errors\": [],\n  \"message\": \"error message\",\n  \"status\": 400\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"errors\": [],\n  \"message\": \"error message\",\n  \"status\": 400\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  List of error details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Error description"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - HTTP status code"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some common status codes and messages are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"table","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"thead","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Number"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Message"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"th","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Explanation"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tbody","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"200"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OK"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The request succeeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"201"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Resource creation"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"A resource was created."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"401"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The API key is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"404"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Not found"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The resource was not found."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"429"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Rate limit exceeded"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Too many requests. Wait a moment and try again."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"tr","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"500"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Server error"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"td","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Internal error. Wait a moment and try again. If the issue persists, "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"target":"_blank","href":"https://help.esper.io/hc/en-us/articles/14800200348561-Contacting-Esper-Support"}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"contact Esper."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See how our systems are doing by checking our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://status.esper.cloud/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"status page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/openapi/section/errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To ensure quality of service for all customers, we enforce rate limits for API requests. Most customers won’t hit this limit with normal use. In case you experience 429 or rate limit exceeded errors, we recommend the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try sending requests in batches."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Begin with about 20 requests at a time and building up from there."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure your scripts are efficient and don’t contain redundant calls."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reach out to your account manager to discuss your options."},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/rate-limits"}]}]}},{"type":"link","label":"Introduction","link":"/openapi/section/introduction","routeSlug":"/openapi/section/introduction","content":null},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication","content":null},{"type":"link","label":"Pagination","link":"/openapi/section/pagination","routeSlug":"/openapi/section/pagination","content":null},{"type":"link","label":"Errors","link":"/openapi/section/errors","routeSlug":"/openapi/section/errors","content":null},{"type":"link","label":"Rate Limits","link":"/openapi/section/rate-limits","routeSlug":"/openapi/section/rate-limits","content":null},{"type":"separator","label":"ESPER CLOUD API","content":null},{"type":"group","label":"Company Settings","link":"/openapi/0_company-settings","routeSlug":"/openapi/0_company-settings","items":[{"label":"Get your company settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_company-settings/getenterprise","routeSlug":"/openapi/0_company-settings/getenterprise","metadata":{"seo":{"title":"Get your company settings","description":"Returns company settings. Formerly known as get your enterprise information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnterprise","name":"Get your company settings","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get your company settings","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns company settings. Formerly known as get your enterprise information.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/","href":"0_company-settings/getenterprise","openApiOperationId":"getEnterprise","summary":"Get your company settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterpriseV1"}},"schemaId":"components/schemas/EnterpriseV1"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnterpriseV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterpriseV1"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_company-settings/getenterprise"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/"},{"label":"Partially update company settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_company-settings/partialupdateenterprise","routeSlug":"/openapi/0_company-settings/partialupdateenterprise","metadata":{"seo":{"title":"Partially update company settings","description":"Returns updated company settings. Formerly known as partial update enterprise information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialUpdateEnterprise","name":"Partially update company settings","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update company settings","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns updated company settings.\nFormerly known as partial update enterprise information.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterpriseUpdateV1"}},"schemaId":"components/schemas/EnterpriseUpdateV1","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/enterprise/{enterprise_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/EnterpriseUpdateV1"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/","href":"0_company-settings/partialupdateenterprise","openApiOperationId":"partialUpdateEnterprise","summary":"Partially update company settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/EnterpriseUpdateV1","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterpriseUpdateV1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterpriseV1"}},"schemaId":"components/schemas/EnterpriseV1"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnterpriseV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterpriseV1"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_company-settings/partialupdateenterprise"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/"}],"content":{"contentType":"group","meta":{"name":"0_Company Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Settings","showPageActions":true},{"nodeType":"markdoc","content":"The Company Settings API manage the account information set up for your organization. Formerly known as Enterprise Information."},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12656541757457-Introduction-to-Company-Settings","description":"Find out more about Company Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/","summary":"Get your company settings","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_company-settings/getenterprise","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/","summary":"Partially update company settings","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_company-settings/partialupdateenterprise","deprecated":false}]}]}]}]}},{"type":"group","label":"Application","link":"/openapi/0_application","routeSlug":"/openapi/0_application","items":[{"label":"List apps in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getallapplications","routeSlug":"/openapi/0_application/getallapplications","metadata":{"seo":{"title":"List apps in enterprise","description":"Returns Application list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllApplications","name":"List apps in enterprise","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List apps in enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Application list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"application_name","in":"query","schemaId":"schema_300","description":"filter by application name"},{"name":"package_name","in":"query","schemaId":"schema_300","description":"filter by package name"},{"name":"package_name_exact","in":"query","schemaId":"schema_300","description":"filter by package name (exact match)"},{"name":"has_uploaded_version","in":"query","schemaId":"schema_301","description":"Returns applications having atleast one version uploaded"},{"name":"category","in":"query","schemaId":"schema_300","description":"filter by category"},{"name":"supported_sdk","in":"query","schemaId":"schema_302","description":"filter by supported sdk versions"},{"name":"is_active","in":"query","schemaId":"schema_301","description":"filter by active applications"},{"name":"is_hidden","in":"query","schemaId":"schema_303","description":"filter default esper apps"},{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"filter applications created after a given timestamp"},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"filter applications created before a given timestamp"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304","description":"filter applications updated after a given timestamp"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304","description":"filter applications updated before a given timestamp"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/application/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"application_name","in":"query","schemaId":"schema_300"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"package_name_exact","in":"query","schemaId":"schema_300"},{"name":"has_uploaded_version","in":"query","schemaId":"schema_301"},{"name":"category","in":"query","schemaId":"schema_300"},{"name":"supported_sdk","in":"query","schemaId":"schema_302"},{"name":"is_active","in":"query","schemaId":"schema_301"},{"name":"is_hidden","in":"query","schemaId":"schema_303"},{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/enterprise/{enterprise_id}/application/","href":"0_application/getallapplications","openApiOperationId":"getAllApplications","summary":"List apps in enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307"}},"schemaId":"schema_307"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_307"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getallapplications"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/"},{"label":"Get application information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getapplication","routeSlug":"/openapi/0_application/getapplication","metadata":{"seo":{"title":"Get application information","description":"Returns Application instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplication","name":"Get application information","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get application information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Application instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/application/{application_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/application/{application_id}/","href":"0_application/getapplication","openApiOperationId":"getApplication","summary":"Get application information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}},"schemaId":"components/schemas/Application"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Application","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Application"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getapplication"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"Delete an application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/deleteapplication","routeSlug":"/openapi/0_application/deleteapplication","metadata":{"seo":{"title":"Delete an application","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplication","name":"Delete an application","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an application","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enterprise/{enterprise_id}/application/{application_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/application/{application_id}/","href":"0_application/deleteapplication","openApiOperationId":"deleteApplication","summary":"Delete an application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/deleteapplication"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"List App versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getappversions","routeSlug":"/openapi/0_application/getappversions","metadata":{"seo":{"title":"List App versions","description":"Returns AppVersion list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppVersions","name":"List App versions","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List App versions","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns AppVersion list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version_code","in":"query","schemaId":"schema_300","description":"filter by version code"},{"name":"build_number","in":"query","schemaId":"schema_300","description":"filter by build number"},{"name":"is_g_play","in":"query","schemaId":"schema_301","description":"filter google play applications"},{"name":"approval_status","in":"query","schemaId":"schema_308","description":"filter by approval status"},{"name":"is_enabled","in":"query","schemaId":"schema_301","description":"filter by enabled versions"},{"name":"is_default","in":"query","schemaId":"schema_301","description":"filter by default versions"},{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"filter applications created after a given timestamp"},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"filter applications created before a given timestamp"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304","description":"filter applications updated after a given timestamp"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304","description":"filter applications updated before a given timestamp"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."},{"name":"ordering","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order result set by field name."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"installed_count: order by asc"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-installed_count: order by desc"},"children":[]}]}]}]}]}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/application/{application_id}/version/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"version_code","in":"query","schemaId":"schema_300"},{"name":"build_number","in":"query","schemaId":"schema_300"},{"name":"is_g_play","in":"query","schemaId":"schema_301"},{"name":"approval_status","in":"query","schemaId":"schema_308"},{"name":"is_enabled","in":"query","schemaId":"schema_301"},{"name":"is_default","in":"query","schemaId":"schema_301"},{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"},{"name":"ordering","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/enterprise/{enterprise_id}/application/{application_id}/version/","href":"0_application/getappversions","openApiOperationId":"getAppVersions","summary":"List App versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getappversions"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/"},{"label":"Get app version information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getappversion","routeSlug":"/openapi/0_application/getappversion","metadata":{"seo":{"title":"Get app version information","description":"Returns AppVersion instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppVersion","name":"Get app version information","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get app version information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns AppVersion instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"request_id","in":"query","schemaId":"schema_300","description":"If this value exists in cache, delete the application and cache entry."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"request_id","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","href":"0_application/getappversion","openApiOperationId":"getAppVersion","summary":"Get app version information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersion"}},"schemaId":"components/schemas/AppVersion"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppVersion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersion"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getappversion"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Delete app version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/deleteappversion","routeSlug":"/openapi/0_application/deleteappversion","metadata":{"seo":{"title":"Delete app version","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppVersion","name":"Delete app version","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete app version","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","href":"0_application/deleteappversion","openApiOperationId":"deleteAppVersion","summary":"Delete app version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No request id is provided and the application is linked to one or more templates. Returns a request_id. Call with this request id to delete the resource."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionDelete"}},"schemaId":"components/schemas/AppVersionDelete"},{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppVersionDelete","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionDelete"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/deleteappversion"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Patch an App version instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/patchappversion","routeSlug":"/openapi/0_application/patchappversion","metadata":{"seo":{"title":"Patch an App version instance","description":"Patch an App version instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAppVersion","name":"Patch an App version instance","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch an App version instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_310"}},"schemaId":"schema_310","pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_310"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","href":"0_application/patchappversion","openApiOperationId":"patchAppVersion","summary":"Patch an App version instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_310","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_310"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersion"}},"schemaId":"components/schemas/AppVersion"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppVersion","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersion"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/patchappversion"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"List install devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getinstalldevices","routeSlug":"/openapi/0_application/getinstalldevices","metadata":{"seo":{"title":"List install devices","description":"Returns list of devices with the specified app version installed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstallDevices","name":"List install devices","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List install devices","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of devices with the specified app version installed"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A search term, search based on device name, device alias_name, group name"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_302","description":"Number of results to return per page"},{"name":"offset","in":"query","schemaId":"schema_302","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"search","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices","href":"0_application/getinstalldevices","openApiOperationId":"getInstallDevices","summary":"List install devices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_311"}},"schemaId":"schema_311"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_311","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_311"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getinstalldevices"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices"},{"label":"Upload an application to enterprise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/upload","routeSlug":"/openapi/0_application/upload","metadata":{"seo":{"title":"Upload an application to enterprise","description":"Returns application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upload","name":"Upload an application to enterprise","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1upload~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload an application to enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1upload~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data","application/x-www-form-urlencoded"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_312"},"application/x-www-form-urlencoded":{"schemaId":"schema_312"}},"schemaId":"schema_312","pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1upload~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/{enterprise_id}/application/upload/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_312"},"application/x-www-form-urlencoded":{"schemaId":"schema_312"}},"responseCodes":["201","400","401","403","415","500"],"pointer":"/enterprise/{enterprise_id}/application/upload/","href":"0_application/upload","openApiOperationId":"upload","summary":"Upload an application to enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_312","mediaTypes":["multipart/form-data","application/x-www-form-urlencoded"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_312"},"application/x-www-form-urlencoded":{"schemaId":"schema_312"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_313"}},"schemaId":"schema_313"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1application~1upload~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_313","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_313"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/upload"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/application/upload/"},{"label":"List Google enterprises","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getemminstances","routeSlug":"/openapi/0_application/getemminstances","metadata":{"seo":{"title":"List Google enterprises","description":"Returns enterprise instances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEMMInstances","name":"List Google enterprises","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Google enterprises","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns enterprise instances"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/emm","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm","href":"0_application/getemminstances","openApiOperationId":"getEMMInstances","summary":"List Google enterprises"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_314"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getemminstances"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm"},{"label":"Get Google enterprise information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getemminstance","routeSlug":"/openapi/0_application/getemminstance","metadata":{"seo":{"title":"Get Google enterprise information","description":"Returns enterprise instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEMMInstance","name":"Get Google enterprise information","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Google enterprise information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns enterprise instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}","href":"0_application/getemminstance","openApiOperationId":"getEMMInstance","summary":"Get Google enterprise information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEnterprise"}},"schemaId":"components/schemas/GoogleEnterprise"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleEnterprise","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEnterprise"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getemminstance"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}"},{"label":"List webtokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getwebtokens","routeSlug":"/openapi/0_application/getwebtokens","metadata":{"seo":{"title":"List webtokens","description":"Returns list of webtokens"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebtokens","name":"List webtokens","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webtokens","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of webtokens"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/","href":"0_application/getwebtokens","openApiOperationId":"getWebtokens","summary":"List webtokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}},"schemaId":"schema_315"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_315","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_315"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getwebtokens"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/"},{"label":"Creates a webtoken instance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/createwebtoken","routeSlug":"/openapi/0_application/createwebtoken","metadata":{"seo":{"title":"Creates a webtoken instance","description":"Returns webtoken instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebtoken","name":"Creates a webtoken instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a webtoken instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns webtoken instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdate"}},"schemaId":"components/schemas/GoogleWebTokenUpdate","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdate"}},"responseCodes":["201","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/","href":"0_application/createwebtoken","openApiOperationId":"createWebtoken","summary":"Creates a webtoken instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleWebTokenUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}},"schemaId":"components/schemas/GoogleWebToken"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/GoogleWebToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/createwebtoken"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/"},{"label":"Get webtoken instance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getwebtokeninstance","routeSlug":"/openapi/0_application/getwebtokeninstance","metadata":{"seo":{"title":"Get webtoken instance","description":"Returns webtoken instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebtokenInstance","name":"Get webtoken instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webtoken instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns webtoken instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"webtoken_id","in":"path","schemaId":"schema_300","description":"An integer identifying the webtoken.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"webtoken_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","href":"0_application/getwebtokeninstance","openApiOperationId":"getWebtokenInstance","summary":"Get webtoken instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}},"schemaId":"components/schemas/GoogleWebToken"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleWebToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getwebtokeninstance"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"Updates webtoken instance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/updatewebtokeninstance","routeSlug":"/openapi/0_application/updatewebtokeninstance","metadata":{"seo":{"title":"Updates webtoken instance","description":"Returns webtoken instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebtokenInstance","name":"Updates webtoken instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates webtoken instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns webtoken instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"webtoken_id","in":"path","schemaId":"schema_300","description":"An integer identifying the webtoken.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdate"}},"schemaId":"components/schemas/GoogleWebTokenUpdate","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"webtoken_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdate"}},"responseCodes":["200","400","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","href":"0_application/updatewebtokeninstance","openApiOperationId":"updateWebtokenInstance","summary":"Updates webtoken instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleWebTokenUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}},"schemaId":"components/schemas/GoogleWebToken"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleWebToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/updatewebtokeninstance"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"Patches webtoken instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/patchwebtokeninstance","routeSlug":"/openapi/0_application/patchwebtokeninstance","metadata":{"seo":{"title":"Patches webtoken instance","description":"Returns webtoken instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWebtokenInstance","name":"Patches webtoken instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patches webtoken instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns webtoken instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"webtoken_id","in":"path","schemaId":"schema_300","description":"An integer identifying the webtoken.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdateNoRequirements"}},"schemaId":"components/schemas/GoogleWebTokenUpdateNoRequirements","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"webtoken_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdateNoRequirements"}},"responseCodes":["200","400","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","href":"0_application/patchwebtokeninstance","openApiOperationId":"patchWebtokenInstance","summary":"Patches webtoken instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleWebTokenUpdateNoRequirements","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleWebTokenUpdateNoRequirements"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}},"schemaId":"components/schemas/GoogleWebToken"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleWebToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleWebToken"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/patchwebtokeninstance"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"Deletes a webtoken instance","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/deletewebtokeninstance","routeSlug":"/openapi/0_application/deletewebtokeninstance","metadata":{"seo":{"title":"Deletes a webtoken instance","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebtokenInstance","name":"Deletes a webtoken instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a webtoken instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"webtoken_id","in":"path","schemaId":"schema_300","description":"An integer identifying the webtoken.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"webtoken_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","href":"0_application/deletewebtokeninstance","openApiOperationId":"deleteWebtokenInstance","summary":"Deletes a webtoken instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1webtoken~1{webtoken_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/deletewebtokeninstance"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}"},{"label":"List Google Play applications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getgoogleapps","routeSlug":"/openapi/0_application/getgoogleapps","metadata":{"seo":{"title":"List Google Play applications","description":"Returns list of Google Play applications"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGoogleApps","name":"List Google Play applications","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Google Play applications","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of Google Play applications"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"google_product_id","in":"query","schemaId":"schema_300","description":"filter by Google product id"},{"name":"package_name","in":"query","schemaId":"schema_300","description":"filter by package name"},{"name":"created_on","in":"query","schemaId":"schema_316","description":"filter by date app created"},{"name":"updated_on","in":"query","schemaId":"schema_316","description":"filter by date app updated"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[{"name":"google_product_id","in":"query","schemaId":"schema_300"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"created_on","in":"query","schemaId":"schema_316"},{"name":"updated_on","in":"query","schemaId":"schema_316"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/","href":"0_application/getgoogleapps","openApiOperationId":"getGoogleApps","summary":"List Google Play applications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}},"schemaId":"schema_317"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_317","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getgoogleapps"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/"},{"label":"Post a Google play application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/addgoogleapp","routeSlug":"/openapi/0_application/addgoogleapp","metadata":{"seo":{"title":"Post a Google play application","description":"Returns instance of Google application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addGoogleApp","name":"Post a Google play application","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post a Google play application","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of Google application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}},"schemaId":"components/schemas/GoogleProduct","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}},"responseCodes":["201","400","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/","href":"0_application/addgoogleapp","openApiOperationId":"addGoogleApp","summary":"Post a Google play application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}},"schemaId":"components/schemas/GoogleProduct"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/GoogleProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/addgoogleapp"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/"},{"label":"Get application information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getappinfo","routeSlug":"/openapi/0_application/getappinfo","metadata":{"seo":{"title":"Get application information","description":"Returns application instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppInfo","name":"Get application information","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get application information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns application instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"product_id","in":"path","schemaId":"schema_300","description":"A string identifying the product.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","href":"0_application/getappinfo","openApiOperationId":"getAppInfo","summary":"Get application information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}},"schemaId":"components/schemas/GoogleProduct"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getappinfo"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"Update application instance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/updateappinfo","routeSlug":"/openapi/0_application/updateappinfo","metadata":{"seo":{"title":"Update application instance","description":"Returns application instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppInfo","name":"Update application instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update application instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns application instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"product_id","in":"path","schemaId":"schema_300","description":"A string identifying the product.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_318"}},"schemaId":"schema_318","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_318"}},"responseCodes":["200","204","400","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","href":"0_application/updateappinfo","openApiOperationId":"updateAppInfo","summary":"Update application instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_318","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_318"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}},"schemaId":"components/schemas/GoogleProduct"},{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleProduct"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/updateappinfo"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"Patch application instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/patchappinfo","routeSlug":"/openapi/0_application/patchappinfo","metadata":{"seo":{"title":"Patch application instance","description":"Returns application instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAppInfo","name":"Patch application instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch application instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns application instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"product_id","in":"path","schemaId":"schema_300","description":"A string identifying the product.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_319"}},"schemaId":"schema_319","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_319"}},"responseCodes":["200","204","400","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","href":"0_application/patchappinfo","openApiOperationId":"patchAppInfo","summary":"Patch application instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_319","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_319"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchGoogleProduct"}},"schemaId":"components/schemas/PatchGoogleProduct"},{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatchGoogleProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatchGoogleProduct"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/patchappinfo"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"Delete application instance","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/deleteappinstance","routeSlug":"/openapi/0_application/deleteappinstance","metadata":{"seo":{"title":"Delete application instance","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppInstance","name":"Delete application instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete application instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"product_id","in":"path","schemaId":"schema_300","description":"A string identifying the product.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","href":"0_application/deleteappinstance","openApiOperationId":"deleteAppInstance","summary":"Delete application instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/deleteappinstance"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}"},{"label":"List product installations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/listproducts","routeSlug":"/openapi/0_application/listproducts","metadata":{"seo":{"title":"List product installations","description":"Returns list of product installations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProducts","name":"List product installations","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}~1install~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List product installations","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of product installations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"emm_id","in":"path","schemaId":"schema_302","description":"An integer representing the ID of enterprise.","required":true},{"name":"product_id","in":"path","schemaId":"schema_300","description":"A string identifying the product.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}~1install~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"google_product","in":"query","schemaId":"schema_300","description":"Filter by Google product"},{"name":"google_device","in":"query","schemaId":"schema_300","description":"Filter by Google device"},{"name":"install_state","in":"query","schemaId":"schema_300","description":"Filter by install state"},{"name":"version_code","in":"query","schemaId":"schema_300","description":"Filter by version code"},{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"filter installations created after a given timestamp"},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"filter installations created before a given timestamp"},{"name":"is_active","in":"query","schemaId":"schema_301","description":"filter by active installations"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}~1install~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}/install/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"emm_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"product_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"google_product","in":"query","schemaId":"schema_300"},{"name":"google_device","in":"query","schemaId":"schema_300"},{"name":"install_state","in":"query","schemaId":"schema_300"},{"name":"version_code","in":"query","schemaId":"schema_300"},{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"is_active","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}/install/","href":"0_application/listproducts","openApiOperationId":"listProducts","summary":"List product installations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_320"}},"schemaId":"schema_320"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1emm~1{emm_id}~1product~1{product_id}~1install~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_320","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_320"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/listproducts"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}/install/"},{"label":"Gets minimum information regarding application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application/getminappinfo","routeSlug":"/openapi/0_application/getminappinfo","metadata":{"seo":{"title":"Gets minimum information regarding application","description":"Returns id and package name of application"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMinAppInfo","name":"Gets minimum information regarding application","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1applications-minimal~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets minimum information regarding application","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns id and package name of application"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1applications-minimal~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/applications-minimal/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/applications-minimal/","href":"0_application/getminappinfo","openApiOperationId":"getMinAppInfo","summary":"Gets minimum information regarding application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}},"schemaId":"schema_321"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1applications-minimal~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_321","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application/getminappinfo"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/applications-minimal/"}],"content":{"contentType":"group","meta":{"name":"0_Application"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application","showPageActions":true},{"nodeType":"markdoc","content":"APIs for application management"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12652127923857","description":"Find out more about application management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enterprise/{enterprise_id}/application/","summary":"List apps in enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getallapplications","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/{application_id}/","summary":"Get application information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getapplication","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/{application_id}/","summary":"Delete an application","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/deleteapplication","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/{application_id}/version/","summary":"List App versions","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getappversions","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","summary":"Get app version information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getappversion","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","summary":"Delete app version","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/deleteappversion","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","summary":"Patch an App version instance","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/patchappversion","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices","summary":"List install devices","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getinstalldevices","deprecated":false},{"title":"/enterprise/{enterprise_id}/application/upload/","summary":"Upload an application to enterprise","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/upload","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm","summary":"List Google enterprises","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getemminstances","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}","summary":"Get Google enterprise information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getemminstance","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/","summary":"List webtokens","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getwebtokens","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/","summary":"Creates a webtoken instance","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/createwebtoken","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","summary":"Get webtoken instance","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getwebtokeninstance","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","summary":"Updates webtoken instance","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/updatewebtokeninstance","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","summary":"Patches webtoken instance","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/patchwebtokeninstance","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/webtoken/{webtoken_id}","summary":"Deletes a webtoken instance","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/deletewebtokeninstance","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/","summary":"List Google Play applications","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getgoogleapps","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/","summary":"Post a Google play application","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/addgoogleapp","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","summary":"Get application information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getappinfo","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","summary":"Update application instance","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/updateappinfo","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","summary":"Patch application instance","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/patchappinfo","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}","summary":"Delete application instance","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/deleteappinstance","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/emm/{emm_id}/product/{product_id}/install/","summary":"List product installations","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/listproducts","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/applications-minimal/","summary":"Gets minimum information regarding application","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application/getminappinfo","deprecated":false}]}]}]}]}},{"type":"group","label":"Application V1","link":"/openapi/0_application-v1","routeSlug":"/openapi/0_application-v1","items":[{"label":"List apps in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/getallapplicationsv1","routeSlug":"/openapi/0_application-v1/getallapplicationsv1","metadata":{"seo":{"title":"List apps in enterprise","description":"Returns Application list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllApplicationsV1","name":"List apps in enterprise","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List apps in enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Application list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"application_name","in":"query","schemaId":"schema_300","description":"filter by application name"},{"name":"package_name","in":"query","schemaId":"schema_300","description":"filter by package name"},{"name":"package_name_exact","in":"query","schemaId":"schema_300","description":"filter by package name (exact match)"},{"name":"has_uploaded_version","in":"query","schemaId":"schema_301","description":"Returns applications having atleast one version uploaded"},{"name":"category","in":"query","schemaId":"schema_300","description":"filter by category"},{"name":"supported_sdk","in":"query","schemaId":"schema_302","description":"filter by supported sdk versions"},{"name":"is_active","in":"query","schemaId":"schema_301","description":"filter by active applications"},{"name":"is_hidden","in":"query","schemaId":"schema_303","description":"filter default esper apps"},{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"filter applications created after a given timestamp"},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"filter applications created before a given timestamp"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304","description":"filter applications updated after a given timestamp"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304","description":"filter applications updated before a given timestamp"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/application/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"application_name","in":"query","schemaId":"schema_300"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"package_name_exact","in":"query","schemaId":"schema_300"},{"name":"has_uploaded_version","in":"query","schemaId":"schema_301"},{"name":"category","in":"query","schemaId":"schema_300"},{"name":"supported_sdk","in":"query","schemaId":"schema_302"},{"name":"is_active","in":"query","schemaId":"schema_301"},{"name":"is_hidden","in":"query","schemaId":"schema_303"},{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/","href":"0_application-v1/getallapplicationsv1","openApiOperationId":"getAllApplicationsV1","summary":"List apps in enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}},"schemaId":"schema_322"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_322","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_322"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/getallapplicationsv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/"},{"label":"Get application information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/getapplicationv1","routeSlug":"/openapi/0_application-v1/getapplicationv1","metadata":{"seo":{"title":"Get application information","description":"Returns Application instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationv1","name":"Get application information","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get application information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Application instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/application/{application_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/{application_id}/","href":"0_application-v1/getapplicationv1","openApiOperationId":"getApplicationv1","summary":"Get application information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationV1"}},"schemaId":"components/schemas/ApplicationV1"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationV1"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/getapplicationv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"Delete an application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/deleteapplicationv1","routeSlug":"/openapi/0_application-v1/deleteapplicationv1","metadata":{"seo":{"title":"Delete an application","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationV1","name":"Delete an application","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an application","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/enterprise/{enterprise_id}/application/{application_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/{application_id}/","href":"0_application-v1/deleteapplicationv1","openApiOperationId":"deleteApplicationV1","summary":"Delete an application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/deleteapplicationv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/"},{"label":"List App versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/getappversionsv1","routeSlug":"/openapi/0_application-v1/getappversionsv1","metadata":{"seo":{"title":"List App versions","description":"Returns AppVersion list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppVersionsV1","name":"List App versions","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List App versions","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns AppVersion list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"version_code","in":"query","schemaId":"schema_300","description":"filter by version code"},{"name":"build_number","in":"query","schemaId":"schema_300","description":"filter by build number"},{"name":"is_g_play","in":"query","schemaId":"schema_301","description":"filter google play applications"},{"name":"approval_status","in":"query","schemaId":"schema_308","description":"filter by approval status"},{"name":"is_enabled","in":"query","schemaId":"schema_301","description":"filter by enabled versions"},{"name":"is_default","in":"query","schemaId":"schema_301","description":"filter by default versions"},{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"filter applications created after a given timestamp"},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"filter applications created before a given timestamp"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304","description":"filter applications updated after a given timestamp"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304","description":"filter applications updated before a given timestamp"},{"name":"limit","in":"query","schemaId":"schema_302","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."},{"name":"ordering","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order result set by field name."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"installed_count: order by asc"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-installed_count: order by desc"},"children":[]}]}]}]}]}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"version_code","in":"query","schemaId":"schema_300"},{"name":"build_number","in":"query","schemaId":"schema_300"},{"name":"is_g_play","in":"query","schemaId":"schema_301"},{"name":"approval_status","in":"query","schemaId":"schema_308"},{"name":"is_enabled","in":"query","schemaId":"schema_301"},{"name":"is_default","in":"query","schemaId":"schema_301"},{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_306"},{"name":"ordering","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/","href":"0_application-v1/getappversionsv1","openApiOperationId":"getAppVersionsV1","summary":"List App versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/getappversionsv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/"},{"label":"Get app version information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/getappversionv1","routeSlug":"/openapi/0_application-v1/getappversionv1","metadata":{"seo":{"title":"Get app version information","description":"Returns AppVersion instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppVersionV1","name":"Get app version information","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get app version information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns AppVersion instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","href":"0_application-v1/getappversionv1","openApiOperationId":"getAppVersionV1","summary":"Get app version information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionV1"}},"schemaId":"components/schemas/AppVersionV1"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppVersionV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionV1"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/getappversionv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Delete app version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/deleteappversionv1","routeSlug":"/openapi/0_application-v1/deleteappversionv1","metadata":{"seo":{"title":"Delete app version","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAppVersionV1","name":"Delete app version","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete app version","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"request_id","in":"query","schemaId":"schema_300","description":"If this value exists in cache, delete the application and cache entry."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"request_id","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","href":"0_application-v1/deleteappversionv1","openApiOperationId":"deleteAppVersionV1","summary":"Delete app version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No request id is provided and the application is linked to one or more templates. Returns a request_id. Call with this request id to delete the resource."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionDelete"}},"schemaId":"components/schemas/AppVersionDelete"},{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppVersionDelete","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionDelete"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/deleteappversionv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"Patch an App version instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/patchappversionv1","routeSlug":"/openapi/0_application-v1/patchappversionv1","metadata":{"seo":{"title":"Patch an App version instance","description":"Patch an App version instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAppVersionV1","name":"Patch an App version instance","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch an App version instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_324"}},"schemaId":"schema_324","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_324"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","href":"0_application-v1/patchappversionv1","openApiOperationId":"patchAppVersionV1","summary":"Patch an App version instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_324","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_324"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionV1"}},"schemaId":"components/schemas/AppVersionV1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppVersionV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppVersionV1"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/patchappversionv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/"},{"label":"List install devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_application-v1/getinstalldevicesv1","routeSlug":"/openapi/0_application-v1/getinstalldevicesv1","metadata":{"seo":{"title":"List install devices","description":"Returns list of devices with the specified app version installed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstallDevicesV1","name":"List install devices","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List install devices","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of devices with the specified app version installed"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"version_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this app version.","required":true},{"name":"application_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this application.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A search term, search based on device name, device alias_name, group name"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_302","description":"Number of results to return per page"},{"name":"offset","in":"query","schemaId":"schema_302","description":"The initial index from which to return the results"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"search","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices","href":"0_application-v1/getinstalldevicesv1","openApiOperationId":"getInstallDevicesV1","summary":"List install devices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_311"}},"schemaId":"schema_311"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1application~1{application_id}~1version~1{version_id}~1installdevices/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_311","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_311"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_application-v1/getinstalldevicesv1"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices"}],"content":{"contentType":"group","meta":{"name":"0_Application V1"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application V1","showPageActions":true},{"nodeType":"markdoc","content":"APIs for application management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/application/","summary":"List apps in enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/getallapplicationsv1","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/application/{application_id}/","summary":"Get application information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/getapplicationv1","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/application/{application_id}/","summary":"Delete an application","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/deleteapplicationv1","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/","summary":"List App versions","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/getappversionsv1","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","summary":"Get app version information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/getappversionv1","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","summary":"Delete app version","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/deleteappversionv1","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/","summary":"Patch an App version instance","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/patchappversionv1","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/application/{application_id}/version/{version_id}/installdevices","summary":"List install devices","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_application-v1/getinstalldevicesv1","deprecated":false}]}]}]}]}},{"type":"group","label":"AndroidDevice","link":"/openapi/0_androiddevice","routeSlug":"/openapi/0_androiddevice","items":[{"label":"Fetch all devices in an enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/getalldevices","routeSlug":"/openapi/0_androiddevice/getalldevices","metadata":{"seo":{"title":"Fetch all devices in an enterprise","description":"Returns a list of devices"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllDevices","name":"Fetch all devices in an enterprise","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch all devices in an enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of devices"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"ID of the enterprise","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_300","description":"filter by device name"},{"name":"group","in":"query","schemaId":"schema_299","description":"filter by group id. It will list all the devices under this gorup including the subgroups"},{"name":"imei","in":"query","schemaId":"schema_300","description":"filter by imei"},{"name":"serial","in":"query","schemaId":"schema_300","description":"filter by serial number"},{"name":"state","in":"query","schemaId":"schema_325"},{"name":"brand","in":"query","schemaId":"schema_300","description":"filter by brand"},{"name":"is_gms","in":"query","schemaId":"schema_301","description":"filter for gms devices"},{"name":"search","in":"query","schemaId":"schema_300","description":"A search term. Search by device name, imei or mac address"},{"name":"tags","in":"query","schemaId":"schema_300","description":"A partial text search for device tags"},{"name":"assigned_blueprint_id","in":"query","schemaId":"schema_299","description":"Filter by assigned blueprint id"},{"name":"current_blueprint_id","in":"query","schemaId":"schema_299","description":"Filter by current blueprint id"},{"name":"current_blueprint_version_id","in":"query","schemaId":"schema_299","description":"Filter by current blueprint version id"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/device/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"name","in":"query","schemaId":"schema_300"},{"name":"group","in":"query","schemaId":"schema_299"},{"name":"imei","in":"query","schemaId":"schema_300"},{"name":"serial","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"components/schemas/DeviceStateEnum"},{"name":"brand","in":"query","schemaId":"schema_300"},{"name":"is_gms","in":"query","schemaId":"schema_301"},{"name":"search","in":"query","schemaId":"schema_300"},{"name":"tags","in":"query","schemaId":"schema_300"},{"name":"assigned_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id","in":"query","schemaId":"schema_299"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/device/","href":"0_androiddevice/getalldevices","openApiOperationId":"getAllDevices","summary":"Fetch all devices in an enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}},"schemaId":"schema_326"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_326","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/getalldevices"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/"},{"label":"Fetch device details by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/getdevicebyid","routeSlug":"/openapi/0_androiddevice/getdevicebyid","metadata":{"seo":{"title":"Fetch device details by ID","description":"Returns details of a device"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceById","name":"Fetch device details by ID","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch device details by ID","badges":[{"name":"Legacy","color":"orange"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns details of a device"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"ID of the enterprise","required":true},{"name":"device_id","in":"path","schemaId":"schema_299","description":"ID of the device","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/device/{device_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/enterprise/{enterprise_id}/device/{device_id}/","href":"0_androiddevice/getdevicebyid","openApiOperationId":"getDeviceById","summary":"Fetch device details by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceInfo"}},"schemaId":"components/schemas/DeviceInfo"},{"code":"400","description":"Bad request"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceInfo"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/getdevicebyid"}],"panels":[]}]},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/"},{"label":"List all device apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/getdeviceapps","routeSlug":"/openapi/0_androiddevice/getdeviceapps","metadata":{"seo":{"title":"List all device apps","description":"Returns DeviceApp list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceApps","name":"List all device apps","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1app~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all device apps","badges":[{"name":"Legacy","color":"orange"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns DeviceApp list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"device_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying device.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1app~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"package_name","in":"query","schemaId":"schema_300","description":"Filter by Package name"},{"name":"whitelisted","in":"query","schemaId":"schema_300","description":"Whitelist filter"},{"name":"search","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A search term. Search by app_name."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_302","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1app~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/device/{device_id}/app/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"whitelisted","in":"query","schemaId":"schema_300"},{"name":"search","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/device/{device_id}/app/","href":"0_androiddevice/getdeviceapps","openApiOperationId":"getDeviceApps","summary":"List all device apps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}},"schemaId":"schema_327"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1app~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_327","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_327"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/getdeviceapps"}],"panels":[]}]},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/app/"},{"label":"Get device app details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/getdeviceappbyid","routeSlug":"/openapi/0_androiddevice/getdeviceappbyid","metadata":{"seo":{"title":"Get device app details","description":"Returns DeviceApp instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceAppById","name":"Get device app details","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1app~1{app_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get device app details","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns DeviceApp instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"app_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this device app.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this device.","required":true},{"name":"device_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enteprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1app~1{app_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/device/{device_id}/app/{app_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"app_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/device/{device_id}/app/{app_id}/","href":"0_androiddevice/getdeviceappbyid","openApiOperationId":"getDeviceAppById","summary":"Get device app details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceApp"}},"schemaId":"components/schemas/DeviceApp"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1app~1{app_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceApp","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceApp"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/getdeviceappbyid"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/app/{app_id}/"},{"label":"List installed apps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/getappinstalls","routeSlug":"/openapi/0_androiddevice/getappinstalls","metadata":{"seo":{"title":"List installed apps","description":"Returns AppInstall list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppInstalls","name":"List installed apps","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1install~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List installed apps","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns AppInstall list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"device_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying device.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1install~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"device","in":"query","schemaId":"schema_300","description":"filter by device id"},{"name":"package_name","in":"query","schemaId":"schema_300","description":"filter by package name"},{"name":"application_name","in":"query","schemaId":"schema_300","description":"filter by application name"},{"name":"install_state","in":"query","schemaId":"schema_300","description":"filter by install state"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1install~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/device/{device_id}/install/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"device","in":"query","schemaId":"schema_300"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"application_name","in":"query","schemaId":"schema_300"},{"name":"install_state","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/device/{device_id}/install/","href":"0_androiddevice/getappinstalls","openApiOperationId":"getAppInstalls","summary":"List installed apps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1install~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/getappinstalls"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/install/"},{"label":"Get latest device event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/getdeviceevent","routeSlug":"/openapi/0_androiddevice/getdeviceevent","metadata":{"seo":{"title":"Get latest device event","description":"Returns DeviceStatus instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceEvent","name":"Get latest device event","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1status~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get latest device event","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns DeviceStatus instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"device_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying device.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1status~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"latest_event","in":"query","schemaId":"schema_302","description":"Returns the latest event. Must be set to 1.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1status~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/device/{device_id}/status/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"latest_event","in":"query","required":true,"schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/device/{device_id}/status/","href":"0_androiddevice/getdeviceevent","openApiOperationId":"getDeviceEvent","summary":"Get latest device event"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1status~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_329"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/getdeviceevent"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/status/"},{"label":"Download Event Feed for Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get","routeSlug":"/openapi/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get","metadata":{"seo":{"title":"Download Event Feed for Device","description":"Download Event Feed for device, ordered by date the event was created on"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Download Event Feed for Device","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Event Feed for Device","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download Event Feed for device, ordered by date the event was created on"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"device_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the device","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_330","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/device/{device_id}/download/eventfeed/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"limit","in":"query","schemaId":"schema_330"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/enterprise/{enterprise_id}/device/{device_id}/download/eventfeed/","href":"0_androiddevice/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get","summary":"Download Event Feed for Device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/device/{device_id}/download/eventfeed/"},{"label":"Download Event Feed for Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get","routeSlug":"/openapi/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get","metadata":{"seo":{"title":"Download Event Feed for Group","description":"Download Event Feed for group, ordered by date the event was created on"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Download Event Feed for Group","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Event Feed for Group","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download Event Feed for group, ordered by date the event was created on"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"group_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the group","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_330","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/group/{group_id}/download/eventfeed/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"limit","in":"query","schemaId":"schema_330"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/enterprise/{enterprise_id}/group/{group_id}/download/eventfeed/","href":"0_androiddevice/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get","summary":"Download Event Feed for Group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/group/{group_id}/download/eventfeed/"},{"label":"Lists event feed for device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_androiddevice/geteventfeed","routeSlug":"/openapi/0_androiddevice/geteventfeed","metadata":{"seo":{"title":"Lists event feed for device","description":"Returns event feed for device, ordered by date the event was created on"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEventFeed","name":"Lists event feed for device","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1device~1{device_id}~1report~1eventfeed~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists event feed for device","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns event feed for device, ordered by date the event was created on"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"device_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the device","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1device~1{device_id}~1report~1eventfeed~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1device~1{device_id}~1report~1eventfeed~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/device/{device_id}/report/eventfeed/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v1/enterprise/{enterprise_id}/device/{device_id}/report/eventfeed/","href":"0_androiddevice/geteventfeed","openApiOperationId":"getEventFeed","summary":"Lists event feed for device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1device~1{device_id}~1report~1eventfeed~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_331"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_androiddevice/geteventfeed"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/device/{device_id}/report/eventfeed/"}],"content":{"contentType":"group","meta":{"name":"0_AndroidDevice"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AndroidDevice","showPageActions":true},{"nodeType":"markdoc","content":"APIs for android device management"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12523891684369","description":"Find out more about device management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enterprise/{enterprise_id}/device/","summary":"Fetch all devices in an enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_androiddevice/getalldevices","deprecated":false},{"title":"/enterprise/{enterprise_id}/device/{device_id}/","summary":"Fetch device details by ID","prefix":{"name":"get","color":"get"},"badges":[{"name":"Legacy","color":"orange"}],"link":"/0_androiddevice/getdevicebyid","deprecated":false},{"title":"/enterprise/{enterprise_id}/device/{device_id}/app/","summary":"List all device apps","prefix":{"name":"get","color":"get"},"badges":[{"name":"Legacy","color":"orange"}],"link":"/0_androiddevice/getdeviceapps","deprecated":false},{"title":"/enterprise/{enterprise_id}/device/{device_id}/app/{app_id}/","summary":"Get device app details","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_androiddevice/getdeviceappbyid","deprecated":false},{"title":"/enterprise/{enterprise_id}/device/{device_id}/install/","summary":"List installed apps","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_androiddevice/getappinstalls","deprecated":false},{"title":"/enterprise/{enterprise_id}/device/{device_id}/status/","summary":"Get latest device event","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_androiddevice/getdeviceevent","deprecated":false},{"title":"/enterprise/{enterprise_id}/device/{device_id}/download/eventfeed/","summary":"Download Event Feed for Device","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1device~1{device_id}~1download~1eventfeed~1/get","deprecated":false},{"title":"/enterprise/{enterprise_id}/group/{group_id}/download/eventfeed/","summary":"Download Event Feed for Group","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_androiddevice/paths/~1enterprise~1{enterprise_id}~1group~1{group_id}~1download~1eventfeed~1/get","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/device/{device_id}/report/eventfeed/","summary":"Lists event feed for device","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_androiddevice/geteventfeed","deprecated":false}]}]}]}]}},{"type":"group","label":"Device Group","link":"/openapi/0_device-group","routeSlug":"/openapi/0_device-group","items":[{"label":"List device groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/getallgroups","routeSlug":"/openapi/0_device-group/getallgroups","metadata":{"seo":{"title":"List device groups","description":"Get a list of groups in the Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllGroups","name":"List device groups","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List device groups","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of groups in the Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_300","description":"Filter by group name"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"The initial index from which to return the results."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"name","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/devicegroup/","href":"0_device-group/getallgroups","openApiOperationId":"getAllGroups","summary":"List device groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333"}},"schemaId":"schema_333"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_333","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_333"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/getallgroups"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/"},{"label":"Create a device group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/creategroup","routeSlug":"/openapi/0_device-group/creategroup","metadata":{"seo":{"title":"Create a device group","description":"Create a group in Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGroup","name":"Create a device group","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a device group","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a group in Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/DeviceGroupUpdate"}},"schemaId":"components/schemas/DeviceGroupUpdate","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/{enterprise_id}/devicegroup/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/DeviceGroupUpdate"}},"responseCodes":["201","400","401","403","500"],"pointer":"/enterprise/{enterprise_id}/devicegroup/","href":"0_device-group/creategroup","openApiOperationId":"createGroup","summary":"Create a device group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/DeviceGroupUpdate","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/DeviceGroupUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}},"schemaId":"components/schemas/DeviceGroup"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DeviceGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/creategroup"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/"},{"label":"Get device group information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/getgroupbyid","routeSlug":"/openapi/0_device-group/getgroupbyid","metadata":{"seo":{"title":"Get device group information","description":"Find a group by its ID. Use List groups to find a group’s ID in Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupById","name":"Get device group information","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get device group information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find a group by its ID. Use List groups to find a group’s ID in Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this enterprise device group.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","href":"0_device-group/getgroupbyid","openApiOperationId":"getGroupById","summary":"Get device group information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}},"schemaId":"components/schemas/DeviceGroup"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/getgroupbyid"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Update device group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/updategroup","routeSlug":"/openapi/0_device-group/updategroup","metadata":{"seo":{"title":"Update device group","description":"Update a group in Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroup","name":"Update device group","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update device group","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a group in Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this enterprise device group.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"action","in":"query","schemaId":"schema_300","description":"add / remove / rename / move"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/DeviceGroupUpdate"}},"schemaId":"components/schemas/DeviceGroupUpdate","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"action","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/DeviceGroupUpdate"}},"responseCodes":["200","400","401","404","500"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","href":"0_device-group/updategroup","openApiOperationId":"updateGroup","summary":"Update device group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/DeviceGroupUpdate","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/DeviceGroupUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}},"schemaId":"components/schemas/DeviceGroup"},{"code":"400","description":"User update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/updategroup"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Delete a device group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/deletegroup","routeSlug":"/openapi/0_device-group/deletegroup","metadata":{"seo":{"title":"Delete a device group","description":"Delete a group from Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroup","name":"Delete a device group","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a device group","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a group from Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this enterprise device group.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","href":"0_device-group/deletegroup","openApiOperationId":"deleteGroup","summary":"Delete a device group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/deletegroup"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Partially update a device group","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/partialupdategroup","routeSlug":"/openapi/0_device-group/partialupdategroup","metadata":{"seo":{"title":"Partially update a device group","description":"Partially update a group in Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialUpdateGroup","name":"Partially update a device group","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a device group","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially update a group in Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"group_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this enterprise device group.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"action","in":"query","schemaId":"schema_300","description":"add / remove / rename / move"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/DeviceGroupPartialUpdate"}},"schemaId":"components/schemas/DeviceGroupPartialUpdate","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"action","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/DeviceGroupPartialUpdate"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","href":"0_device-group/partialupdategroup","openApiOperationId":"partialUpdateGroup","summary":"Partially update a device group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/DeviceGroupPartialUpdate","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/DeviceGroupPartialUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}},"schemaId":"components/schemas/DeviceGroup"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceGroup"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/partialupdategroup"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/"},{"label":"Upload a thumbnail pic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/uploadgroupthumbnail","routeSlug":"/openapi/0_device-group/uploadgroupthumbnail","metadata":{"seo":{"title":"Upload a thumbnail pic","description":"Upload an image to represent the group in Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadGroupThumbnail","name":"Upload a thumbnail pic","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a thumbnail pic","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload an image to represent the group in Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_334"}},"schemaId":"schema_334","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/{enterprise_id}/devicegroup/thumbnail/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_334"}},"responseCodes":["200"],"pointer":"/enterprise/{enterprise_id}/devicegroup/thumbnail/","href":"0_device-group/uploadgroupthumbnail","openApiOperationId":"uploadGroupThumbnail","summary":"Upload a thumbnail pic"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_334","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_334"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Thumbnail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupThumbnail"}},"schemaId":"components/schemas/GroupThumbnail"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupThumbnail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupThumbnail"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/uploadgroupthumbnail"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/"},{"label":"List thumbnail pics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/listgroupthumbnail","routeSlug":"/openapi/0_device-group/listgroupthumbnail","metadata":{"seo":{"title":"List thumbnail pics","description":"Get a list of group thumbnail image files in Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupThumbnail","name":"List thumbnail pics","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List thumbnail pics","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a list of group thumbnail image files in Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/thumbnail/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/enterprise/{enterprise_id}/devicegroup/thumbnail/","href":"0_device-group/listgroupthumbnail","openApiOperationId":"listGroupThumbnail","summary":"List thumbnail pics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Thumbnail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/listgroupthumbnail"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/"},{"label":"Get thumbnail detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/getgroupthumbnail","routeSlug":"/openapi/0_device-group/getgroupthumbnail","metadata":{"seo":{"title":"Get thumbnail detail","description":"Get a thumbnail by its ID. Use List thumbnail pics to find thumbnail IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupThumbnail","name":"Get thumbnail detail","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1{thumbnail_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get thumbnail detail","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a thumbnail by its ID. Use List thumbnail pics to find thumbnail IDs. "},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"thumbnail_id","in":"path","schemaId":"schema_299","description":"Group thumbnail ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1{thumbnail_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"thumbnail_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/","href":"0_device-group/getgroupthumbnail","openApiOperationId":"getGroupThumbnail","summary":"Get thumbnail detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Thumbnail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupThumbnail"}},"schemaId":"components/schemas/GroupThumbnail"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1{thumbnail_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupThumbnail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupThumbnail"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/getgroupthumbnail"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/"},{"label":"Delete group thumbnail","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/deletegroupthumbnail","routeSlug":"/openapi/0_device-group/deletegroupthumbnail","metadata":{"seo":{"title":"Delete group thumbnail","description":"Delete a thumbnail in Devices & Groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroupThumbnail","name":"Delete group thumbnail","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1{thumbnail_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete group thumbnail","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a thumbnail in Devices & Groups."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"thumbnail_id","in":"path","schemaId":"schema_299","description":"Group thumbnail ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1{thumbnail_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"thumbnail_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401"],"pointer":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/","href":"0_device-group/deletegroupthumbnail","openApiOperationId":"deleteGroupThumbnail","summary":"Delete group thumbnail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted group thumbnail"},{"code":"401","description":"Group thumbnail delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1thumbnail~1{thumbnail_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/deletegroupthumbnail"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/"},{"label":"List the subgroups of list of groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-group/getallsubgroups","routeSlug":"/openapi/0_device-group/getallsubgroups","metadata":{"seo":{"title":"List the subgroups of list of groups","description":"Returns EnterpriseDeviceGroup list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllSubGroups","name":"List the subgroups of list of groups","isWebhook":false,"pointer":"/paths/~1api~1v2~1subgroups~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the subgroups of list of groups","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns EnterpriseDeviceGroup list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parent_group_ids","in":"query","schemaId":"schema_300","description":"Filter by parent group ids. This is a comma separated list of group ids."},{"name":"immediate","in":"query","schemaId":"schema_303","description":"This is a boolean value. If true, only immediate subgroups are returned."}],"pointer":"/paths/~1api~1v2~1subgroups~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/subgroups/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"parent_group_ids","in":"query","schemaId":"schema_300"},{"name":"immediate","in":"query","schemaId":"schema_303"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v2/subgroups/","href":"0_device-group/getallsubgroups","openApiOperationId":"getAllSubGroups","summary":"List the subgroups of list of groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336"},{"code":"400","description":"Bad Request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1api~1v2~1subgroups~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-group/getallsubgroups"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/api/v2/subgroups/"}],"content":{"contentType":"group","meta":{"name":"0_Device Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Group","showPageActions":true},{"nodeType":"markdoc","content":"APIs for device group management"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12523891684369","description":"Find out more about device group management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enterprise/{enterprise_id}/devicegroup/","summary":"List device groups","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/getallgroups","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/","summary":"Create a device group","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/creategroup","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","summary":"Get device group information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/getgroupbyid","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","summary":"Update device group","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/updategroup","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","summary":"Delete a device group","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/deletegroup","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/","summary":"Partially update a device group","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/partialupdategroup","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/thumbnail/","summary":"Upload a thumbnail pic","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/uploadgroupthumbnail","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/thumbnail/","summary":"List thumbnail pics","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/listgroupthumbnail","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/","summary":"Get thumbnail detail","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/getgroupthumbnail","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/thumbnail/{thumbnail_id}/","summary":"Delete group thumbnail","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/deletegroupthumbnail","deprecated":false},{"title":"/api/v2/subgroups/","summary":"List the subgroups of list of groups","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-group/getallsubgroups","deprecated":false}]}]}]}]}},{"type":"group","label":"Token (Deprecated)","link":"/openapi/0_token-(deprecated)","routeSlug":"/openapi/0_token-(deprecated)","items":[{"label":"Renew Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_token-(deprecated)/renewtoken","routeSlug":"/openapi/0_token-(deprecated)/renewtoken","metadata":{"seo":{"title":"Renew Token","description":"API to renew your token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renewToken","name":"Renew Token","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1developerapp~1{developerapp_id}~1renew-token~1/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Renew Token","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to renew your token"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying this enterprise.","required":true},{"name":"developerapp_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the developerapp","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1developerapp~1{developerapp_id}~1renew-token~1/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"access_token","in":"query","schemaId":"schema_300","description":"Token to be renewed","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1developerapp~1{developerapp_id}~1renew-token~1/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/developerapp/{developerapp_id}/renew-token/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"developerapp_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"access_token","in":"query","required":true,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["201","400","401","403","500"],"pointer":"/v0/enterprise/{enterprise_id}/developerapp/{developerapp_id}/renew-token/","href":"0_token-(deprecated)/renewtoken","openApiOperationId":"renewToken","summary":"Renew Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenRenewV0"}},"schemaId":"components/schemas/TokenRenewV0"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1developerapp~1{developerapp_id}~1renew-token~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TokenRenewV0","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenRenewV0"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_token-(deprecated)/renewtoken"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v0/enterprise/{enterprise_id}/developerapp/{developerapp_id}/renew-token/"},{"label":"Token Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_token-(deprecated)/gettokeninfo","routeSlug":"/openapi/0_token-(deprecated)/gettokeninfo","metadata":{"seo":{"title":"Token Information","description":"API to get resource information associated with your token like your enterprise, user etc"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTokenInfo","name":"Token Information","isWebhook":false,"pointer":"/paths/~1v1~1token-info~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Token Information","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get resource information associated with your token like your enterprise, user etc"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/token-info/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/token-info/","href":"0_token-(deprecated)/gettokeninfo","openApiOperationId":"getTokenInfo","summary":"Token Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenInfoV1"}},"schemaId":"components/schemas/TokenInfoV1"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1token-info~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TokenInfoV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TokenInfoV1"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_token-(deprecated)/gettokeninfo"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/v1/token-info/"}],"content":{"contentType":"group","meta":{"name":"0_Token (Deprecated)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Token (Deprecated)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The following APIs will soon be deprecated. Use the console to manage API keys instead."},"children":[]}]}]}]},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12656959508497","description":"Find out more about API Key generation"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/enterprise/{enterprise_id}/developerapp/{developerapp_id}/renew-token/","summary":"Renew Token","prefix":{"name":"post","color":"post"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_token-(deprecated)/renewtoken","deprecated":false},{"title":"/v1/token-info/","summary":"Token Information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_token-(deprecated)/gettokeninfo","deprecated":false}]}]}]}]}},{"type":"group","label":"Commands V2","link":"/openapi/0_commands-v2","routeSlug":"/openapi/0_commands-v2","items":[{"label":"List command requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_commands-v2/listcommandrequest","routeSlug":"/openapi/0_commands-v2/listcommandrequest","metadata":{"seo":{"title":"List command requests","description":"API to get and filter command requests"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCommandRequest","name":"List command requests","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List command requests","badges":[{"name":"Legacy","color":"orange"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get and filter command requests"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"ID of the enterprise","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"command_type","in":"query","schemaId":"schema_300","description":"Filter by type of command request i.e device, group etc"},{"name":"devices","in":"query","schemaId":"schema_300","description":"Filter by device IDs. Accepts comma separated values."},{"name":"device_type","in":"query","schemaId":"schema_300","description":"Filter by device type i.e active, inactive etc"},{"name":"command","in":"query","schemaId":"schema_300","description":"Filter by command name"},{"name":"issued_by","in":"query","schemaId":"schema_300","description":"Filter by user. Accepts user id."}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/command/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"command_type","in":"query","schemaId":"schema_300"},{"name":"devices","in":"query","schemaId":"schema_300"},{"name":"device_type","in":"query","schemaId":"schema_300"},{"name":"command","in":"query","schemaId":"schema_300"},{"name":"issued_by","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/command/","href":"0_commands-v2/listcommandrequest","openApiOperationId":"listCommandRequest","summary":"List command requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"on successful request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337"}},"schemaId":"schema_337"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_337","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_commands-v2/listcommandrequest"}],"panels":[]}]},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/command/"},{"label":"Create a command request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_commands-v2/createcommand","routeSlug":"/openapi/0_commands-v2/createcommand","metadata":{"seo":{"title":"Create a command request","description":"API to create a command request for the device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCommand","name":"Create a command request","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a command request","badges":[{"name":"Legacy","color":"orange"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to create a command request for the device."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"ID of the enterprise","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/V0CommandRequest"}},"schemaId":"components/schemas/V0CommandRequest","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/post/requestBody","description":"The request body to create a command for set of devices or groups"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/command/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/V0CommandRequest"}},"responseCodes":["201","400","401","403","500"],"pointer":"/v0/enterprise/{enterprise_id}/command/","href":"0_commands-v2/createcommand","openApiOperationId":"createCommand","summary":"Create a command request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/V0CommandRequest","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/V0CommandRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"command request successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V0CommandRequest"}},"schemaId":"components/schemas/V0CommandRequest"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/V0CommandRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/V0CommandRequest"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_commands-v2/createcommand"}],"panels":[]}]},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/command/"},{"label":"get status list for command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_commands-v2/getcommandrequeststatus","routeSlug":"/openapi/0_commands-v2/getcommandrequeststatus","metadata":{"seo":{"title":"get status list for command request","description":"API to get and filter command request status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommandRequestStatus","name":"get status list for command request","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1{request_id}~1status~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"get status list for command request","badges":[{"name":"Legacy","color":"orange"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get and filter command request status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"ID of the enterprise","required":true},{"name":"request_id","in":"path","schemaId":"schema_299","description":"ID for the command request","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1{request_id}~1status~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"device","in":"query","schemaId":"schema_300","description":"Filter status result by device id."},{"name":"state","in":"query","schemaId":"schema_300","description":"Filter by command state"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1{request_id}~1status~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/command/{request_id}/status/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"request_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"device","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/command/{request_id}/status/","href":"0_commands-v2/getcommandrequeststatus","openApiOperationId":"getCommandRequestStatus","summary":"get status list for command request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"on successful request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1command~1{request_id}~1status~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_commands-v2/getcommandrequeststatus"}],"panels":[]}]},"badges":[{"name":"Legacy","color":"orange"}],"httpPath":"/v0/enterprise/{enterprise_id}/command/{request_id}/status/"},{"label":"get command history for device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_commands-v2/getdevicecommandhistory","routeSlug":"/openapi/0_commands-v2/getdevicecommandhistory","metadata":{"seo":{"title":"get command history for device","description":"API to get and filter deivce command history"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceCommandHistory","name":"get command history for device","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1device~1{device_id}~1command-history~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"get command history for device","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get and filter deivce command history"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Id of the enterprise","required":true},{"name":"device_id","in":"path","schemaId":"schema_299","description":"Id for the command request","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1device~1{device_id}~1command-history~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state","in":"query","schemaId":"schema_300","description":"Filter by command state"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1device~1{device_id}~1command-history~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/device/{device_id}/command-history/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"device_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"state","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/device/{device_id}/command-history/","href":"0_commands-v2/getdevicecommandhistory","openApiOperationId":"getDeviceCommandHistory","summary":"get command history for device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"on successful request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1device~1{device_id}~1command-history~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_commands-v2/getdevicecommandhistory"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/device/{device_id}/command-history/"}],"content":{"contentType":"group","meta":{"name":"0_Commands V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commands V2","showPageActions":true},{"nodeType":"markdoc","content":"Commands V2.0 provides advanced device commands capabilities like queuing, support for offline devices, dynamic device set for commands and command history. Commands 2.0 is in active development and we will add support for all the commands soon"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12524618746129","description":"Find out more about commands V2.0"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/enterprise/{enterprise_id}/command/","summary":"List command requests","prefix":{"name":"get","color":"get"},"badges":[{"name":"Legacy","color":"orange"}],"link":"/0_commands-v2/listcommandrequest","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/command/","summary":"Create a command request","prefix":{"name":"post","color":"post"},"badges":[{"name":"Legacy","color":"orange"}],"link":"/0_commands-v2/createcommand","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/command/{request_id}/status/","summary":"get status list for command request","prefix":{"name":"get","color":"get"},"badges":[{"name":"Legacy","color":"orange"}],"link":"/0_commands-v2/getcommandrequeststatus","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/device/{device_id}/command-history/","summary":"get command history for device","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_commands-v2/getdevicecommandhistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Enterprise Policy","link":"/openapi/0_enterprise-policy","routeSlug":"/openapi/0_enterprise-policy","items":[{"label":"List all policies in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_enterprise-policy/listpolicies","routeSlug":"/openapi/0_enterprise-policy/listpolicies","metadata":{"seo":{"title":"List all policies in enterprise","description":"Returns Policies list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPolicies","name":"List all policies in enterprise","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all policies in enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Policies list"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"ID of the enterprise","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_300","description":"filter by policy name"},{"name":"is_active","in":"query","schemaId":"schema_301","description":"filter by Active policies"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/policy/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"name","in":"query","schemaId":"schema_300"},{"name":"is_active","in":"query","schemaId":"schema_301"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/policy/","href":"0_enterprise-policy/listpolicies","openApiOperationId":"listPolicies","summary":"List all policies in enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_enterprise-policy/listpolicies"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/"},{"label":"Create a new Enterprise Policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_enterprise-policy/createpolicy","routeSlug":"/openapi/0_enterprise-policy/createpolicy","metadata":{"seo":{"title":"Create a new Enterprise Policy","description":"API to create a new Enterprise Policy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPolicy","name":"Create a new Enterprise Policy","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Enterprise Policy","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to create a new Enterprise Policy"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"ID of the enterprise","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterprisePolicy"}},"schemaId":"components/schemas/EnterprisePolicy","pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/post/requestBody","description":"The request body to create an Enteprise Policy"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/{enterprise_id}/policy/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/EnterprisePolicy"}},"responseCodes":["201","400","401","403","500"],"pointer":"/enterprise/{enterprise_id}/policy/","href":"0_enterprise-policy/createpolicy","openApiOperationId":"createPolicy","summary":"Create a new Enterprise Policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/EnterprisePolicy","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterprisePolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"command request successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}},"schemaId":"components/schemas/EnterprisePolicy"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/EnterprisePolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_enterprise-policy/createpolicy"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/"},{"label":"Get Enterprise Policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_enterprise-policy/getpolicybyid","routeSlug":"/openapi/0_enterprise-policy/getpolicybyid","metadata":{"seo":{"title":"Get Enterprise Policy","description":"Returns EnterprisePolicy instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPolicyById","name":"Get Enterprise Policy","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Enterprise Policy","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns EnterprisePolicy instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"policy_id","in":"path","schemaId":"schema_302","description":"An integer identifying this enterprise policy.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/policy/{policy_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"policy_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/{enterprise_id}/policy/{policy_id}/","href":"0_enterprise-policy/getpolicybyid","openApiOperationId":"getPolicyById","summary":"Get Enterprise Policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}},"schemaId":"components/schemas/EnterprisePolicy"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnterprisePolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_enterprise-policy/getpolicybyid"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"},{"label":"Update Enterprise Policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_enterprise-policy/updatepolicy","routeSlug":"/openapi/0_enterprise-policy/updatepolicy","metadata":{"seo":{"title":"Update Enterprise Policy","description":"Returns Enterprise Policy instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePolicy","name":"Update Enterprise Policy","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Enterprise Policy","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Enterprise Policy instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"policy_id","in":"path","schemaId":"schema_302","description":"An integer identifying this enterprise policy.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterprisePolicy"}},"schemaId":"components/schemas/EnterprisePolicy","pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/enterprise/{enterprise_id}/policy/{policy_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"policy_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/EnterprisePolicy"}},"responseCodes":["200","400","401","404","500"],"pointer":"/enterprise/{enterprise_id}/policy/{policy_id}/","href":"0_enterprise-policy/updatepolicy","openApiOperationId":"updatePolicy","summary":"Update Enterprise Policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/EnterprisePolicy","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterprisePolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}},"schemaId":"components/schemas/EnterprisePolicy"},{"code":"400","description":"User update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnterprisePolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_enterprise-policy/updatepolicy"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"},{"label":"Delete a Enterprise Policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_enterprise-policy/deleteenterprisepolicy","routeSlug":"/openapi/0_enterprise-policy/deleteenterprisepolicy","metadata":{"seo":{"title":"Delete a Enterprise Policy","description":"Emtpy response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEnterprisePolicy","name":"Delete a Enterprise Policy","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Enterprise Policy","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Emtpy response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"policy_id","in":"path","schemaId":"schema_302","description":"An integer identifying this enterprise policy.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enterprise/{enterprise_id}/policy/{policy_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"policy_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/policy/{policy_id}/","href":"0_enterprise-policy/deleteenterprisepolicy","openApiOperationId":"deleteEnterprisePolicy","summary":"Delete a Enterprise Policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_enterprise-policy/deleteenterprisepolicy"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"},{"label":"Partial update EnterprisePolicy","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_enterprise-policy/partialupdatepolicy","routeSlug":"/openapi/0_enterprise-policy/partialupdatepolicy","metadata":{"seo":{"title":"Partial update EnterprisePolicy","description":"Returns EnterprisePolicy instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialupdatePolicy","name":"Partial update EnterprisePolicy","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial update EnterprisePolicy","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns EnterprisePolicy instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"policy_id","in":"path","schemaId":"schema_302","description":"An integer identifying this enterprise policy.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterprisePolicyPartialUpdate"}},"schemaId":"components/schemas/EnterprisePolicyPartialUpdate","pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enterprise/{enterprise_id}/policy/{policy_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"policy_id","in":"path","required":true,"schemaId":"schema_302"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/EnterprisePolicyPartialUpdate"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/enterprise/{enterprise_id}/policy/{policy_id}/","href":"0_enterprise-policy/partialupdatepolicy","openApiOperationId":"partialupdatePolicy","summary":"Partial update EnterprisePolicy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/EnterprisePolicyPartialUpdate","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/EnterprisePolicyPartialUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}},"schemaId":"components/schemas/EnterprisePolicy"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1policy~1{policy_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EnterprisePolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EnterprisePolicy"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_enterprise-policy/partialupdatepolicy"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/{enterprise_id}/policy/{policy_id}/"}],"content":{"contentType":"group","meta":{"name":"0_Enterprise Policy"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enterprise Policy","showPageActions":true},{"nodeType":"markdoc","content":"APIs to Esper Compliance Policy"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12653153592977","description":"Find out more about Compliance Policy"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enterprise/{enterprise_id}/policy/","summary":"List all policies in enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_enterprise-policy/listpolicies","deprecated":false},{"title":"/enterprise/{enterprise_id}/policy/","summary":"Create a new Enterprise Policy","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_enterprise-policy/createpolicy","deprecated":false},{"title":"/enterprise/{enterprise_id}/policy/{policy_id}/","summary":"Get Enterprise Policy","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_enterprise-policy/getpolicybyid","deprecated":false},{"title":"/enterprise/{enterprise_id}/policy/{policy_id}/","summary":"Update Enterprise Policy","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_enterprise-policy/updatepolicy","deprecated":false},{"title":"/enterprise/{enterprise_id}/policy/{policy_id}/","summary":"Delete a Enterprise Policy","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_enterprise-policy/deleteenterprisepolicy","deprecated":false},{"title":"/enterprise/{enterprise_id}/policy/{policy_id}/","summary":"Partial update EnterprisePolicy","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_enterprise-policy/partialupdatepolicy","deprecated":false}]}]}]}]}},{"type":"group","label":"Geofence","link":"/openapi/0_geofence","routeSlug":"/openapi/0_geofence","items":[{"label":"List Geofences in Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/getallgeofences","routeSlug":"/openapi/0_geofence/getallgeofences","metadata":{"seo":{"title":"List Geofences in Enterprise","description":"API to view all the geofences in an enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllGeofences","name":"List Geofences in Enterprise","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Geofences in Enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to view all the geofences in an enterprise"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_300","description":"A search term."},{"name":"limit","in":"query","schemaId":"schema_302","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_302","description":"The initial index from which to return the results."}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/geofence/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"search","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/geofence/","href":"0_geofence/getallgeofences","openApiOperationId":"getAllGeofences","summary":"List Geofences in Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}},"schemaId":"schema_341"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_341","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/getallgeofences"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/"},{"label":"Get geofence information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/getgeofence","routeSlug":"/openapi/0_geofence/getgeofence","metadata":{"seo":{"title":"Get geofence information","description":"Returns geofence instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGeofence","name":"Get geofence information","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get geofence information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns geofence instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"geofence_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the geofence.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"geofence_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","href":"0_geofence/getgeofence","openApiOperationId":"getGeofence","summary":"Get geofence information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}},"schemaId":"components/schemas/Geofence"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Geofence","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/getgeofence"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Update geofence information","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/updategeofence","routeSlug":"/openapi/0_geofence/updategeofence","metadata":{"seo":{"title":"Update geofence information","description":"Returns geofence instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGeofence","name":"Update geofence information","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update geofence information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns geofence instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"geofence_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the geofence.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/Geofence"}},"schemaId":"components/schemas/Geofence","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"geofence_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/Geofence"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","href":"0_geofence/updategeofence","openApiOperationId":"updateGeofence","summary":"Update geofence information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Geofence","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/Geofence"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}},"schemaId":"components/schemas/Geofence"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Geofence","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/updategeofence"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Delete a geofence","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/deletegeofence","routeSlug":"/openapi/0_geofence/deletegeofence","metadata":{"seo":{"title":"Delete a geofence","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGeofence","name":"Delete a geofence","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a geofence","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"geofence_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the geofence.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"geofence_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","href":"0_geofence/deletegeofence","openApiOperationId":"deleteGeofence","summary":"Delete a geofence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/deletegeofence"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Partially updates geofence information","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/partialupdategeofence","routeSlug":"/openapi/0_geofence/partialupdategeofence","metadata":{"seo":{"title":"Partially updates geofence information","description":"Returns geofence instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialUpdateGeofence","name":"Partially updates geofence information","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates geofence information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns geofence instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"geofence_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the geofence.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/GeofenceUpdate"}},"schemaId":"components/schemas/GeofenceUpdate","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"geofence_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/GeofenceUpdate"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","href":"0_geofence/partialupdategeofence","openApiOperationId":"partialUpdateGeofence","summary":"Partially updates geofence information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GeofenceUpdate","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/GeofenceUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}},"schemaId":"components/schemas/Geofence"},{"code":"400","description":"Bad Request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1geofence~1{geofence_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Geofence","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/partialupdategeofence"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/"},{"label":"Create a geofence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/creategeofence","routeSlug":"/openapi/0_geofence/creategeofence","metadata":{"seo":{"title":"Create a geofence","description":"Returns Geofence instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGeofence","name":"Create a geofence","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a geofence","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Geofence instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/GeofenceCreate"}},"schemaId":"components/schemas/GeofenceCreate","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"components/schemas/GeofenceCreate"}},"responseCodes":["201","400","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/","href":"0_geofence/creategeofence","openApiOperationId":"createGeofence","summary":"Create a geofence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GeofenceCreate","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"components/schemas/GeofenceCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}},"schemaId":"components/schemas/Geofence"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Geofence","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/creategeofence"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/"},{"label":"List Geofences in Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/getgeofencelist","routeSlug":"/openapi/0_geofence/getgeofencelist","metadata":{"seo":{"title":"List Geofences in Enterprise","description":"API to view all the geofences in an enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGeofenceList","name":"List Geofences in Enterprise","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Geofences in Enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to view all the geofences in an enterprise"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_300","description":"A search term."},{"name":"limit","in":"query","schemaId":"schema_302","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_302","description":"The initial index from which to return the results."}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"search","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/","href":"0_geofence/getgeofencelist","openApiOperationId":"getGeofenceList","summary":"List Geofences in Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}},"schemaId":"schema_341"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geo-fence~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_341","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/getgeofencelist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/"},{"label":"Get geofence information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/getthegeofence","routeSlug":"/openapi/0_geofence/getthegeofence","metadata":{"seo":{"title":"Get geofence information","description":"Returns geofence instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTheGeofence","name":"Get geofence information","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geofence~1{geofence_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get geofence information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns geofence instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"geofence_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the geofence.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geofence~1{geofence_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"geofence_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/","href":"0_geofence/getthegeofence","openApiOperationId":"getTheGeofence","summary":"Get geofence information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}},"schemaId":"components/schemas/Geofence"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geofence~1{geofence_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Geofence","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Geofence"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/getthegeofence"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/"},{"label":"Delete a geofence","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_geofence/deletethegeofence","routeSlug":"/openapi/0_geofence/deletethegeofence","metadata":{"seo":{"title":"Delete a geofence","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTheGeofence","name":"Delete a geofence","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geofence~1{geofence_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a geofence","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"geofence_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the geofence.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geofence~1{geofence_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"geofence_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/","href":"0_geofence/deletethegeofence","openApiOperationId":"deleteTheGeofence","summary":"Delete a geofence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1create-apply-geofence~1{geofence_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_geofence/deletethegeofence"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/"}],"content":{"contentType":"group","meta":{"name":"0_Geofence"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Geofence","showPageActions":true},{"nodeType":"markdoc","content":"APIs for geofence management"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12655621844753","description":"Find out more about Geofence"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/enterprise/{enterprise_id}/geofence/","summary":"List Geofences in Enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/getallgeofences","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","summary":"Get geofence information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/getgeofence","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","summary":"Update geofence information","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/updategeofence","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","summary":"Delete a geofence","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/deletegeofence","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/","summary":"Partially updates geofence information","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/partialupdategeofence","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/","summary":"Create a geofence","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/creategeofence","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/create-apply-geo-fence/","summary":"List Geofences in Enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/getgeofencelist","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/","summary":"Get geofence information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/getthegeofence","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/create-apply-geofence/{geofence_id}/","summary":"Delete a geofence","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_geofence/deletethegeofence","deprecated":false}]}]}]}]}},{"type":"group","label":"Content","link":"/openapi/0_content","routeSlug":"/openapi/0_content","items":[{"label":"List content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_content/getallcontent","routeSlug":"/openapi/0_content/getallcontent","metadata":{"seo":{"title":"List content","description":"Get all files in a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllContent","name":"List content","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List content","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all files in a tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"search","in":"query","schemaId":"schema_300","description":"Seach by tags, description"},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"The initial index from which to return the results."}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/content/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"search","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v0/enterprise/{enterprise_id}/content/","href":"0_content/getallcontent","openApiOperationId":"getAllContent","summary":"List content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}},"schemaId":"schema_342"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_342","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_content/getallcontent"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/"},{"label":"Get content information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_content/getcontent","routeSlug":"/openapi/0_content/getcontent","metadata":{"seo":{"title":"Get content information","description":"Get information about a file"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContent","name":"Get content information","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get content information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get information about a file"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying a content instance.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/enterprise/{enterprise_id}/content/{content_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/content/{content_id}/","href":"0_content/getcontent","openApiOperationId":"getContent","summary":"Get content information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Content"}},"schemaId":"components/schemas/Content"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Content","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Content"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_content/getcontent"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/{content_id}/"},{"label":"Delete Content","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_content/deletecontent","routeSlug":"/openapi/0_content/deletecontent","metadata":{"seo":{"title":"Delete Content","description":"Delete content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteContent","name":"Delete Content","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Content","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying a content instance.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v0/enterprise/{enterprise_id}/content/{content_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/v0/enterprise/{enterprise_id}/content/{content_id}/","href":"0_content/deletecontent","openApiOperationId":"deleteContent","summary":"Delete Content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_content/deletecontent"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/{content_id}/"},{"label":"Patch a content instance","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_content/patchcontent","routeSlug":"/openapi/0_content/patchcontent","metadata":{"seo":{"title":"Patch a content instance","description":"Patch a content instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchContent","name":"Patch a content instance","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch a content instance","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"content_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying a content instance.","required":true},{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_343"}},"schemaId":"schema_343","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v0/enterprise/{enterprise_id}/content/{content_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"content_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"*/*":{"schemaId":"schema_343"}},"responseCodes":["200","400","401","403","404","415","500"],"pointer":"/v0/enterprise/{enterprise_id}/content/{content_id}/","href":"0_content/patchcontent","openApiOperationId":"patchContent","summary":"Patch a content instance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_343","mediaTypes":["*/*"],"mediaTypeSchemas":{"*/*":{"schemaId":"schema_343"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Content"}},"schemaId":"components/schemas/Content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1{content_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Content","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Content"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_content/patchcontent"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/{content_id}/"},{"label":"Upload new content","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_content/postcontent","routeSlug":"/openapi/0_content/postcontent","metadata":{"seo":{"title":"Upload new content","description":"Uploaded content to Esper"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postContent","name":"Upload new content","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1upload~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload new content","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uploaded content to Esper"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1upload~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_344"}},"schemaId":"schema_344","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1upload~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/content/upload/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_344"}},"responseCodes":["200","400","401","403","415","500"],"pointer":"/v0/enterprise/{enterprise_id}/content/upload/","href":"0_content/postcontent","openApiOperationId":"postContent","summary":"Upload new content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_344","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_344"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Content"}},"schemaId":"components/schemas/Content"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1upload~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Content","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Content"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_content/postcontent"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/upload/"},{"label":"Upload file to Remote File Manager","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_content/uploadremotefile","routeSlug":"/openapi/0_content/uploadremotefile","metadata":{"seo":{"title":"Upload file to Remote File Manager","description":"Upload file through SCAPI server to REMOTE_FILE_MANAGER bucket. Files are automatically deleted after 1 day."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadRemoteFile","name":"Upload file to Remote File Manager","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload file to Remote File Manager","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload file through SCAPI server to REMOTE_FILE_MANAGER bucket. Files are automatically deleted after 1 day."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_345"}},"schemaId":"schema_345","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/content/remote-file/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_345"}},"responseCodes":["201","400","401","403","413","500"],"pointer":"/v0/enterprise/{enterprise_id}/content/remote-file/","href":"0_content/uploadremotefile","openApiOperationId":"uploadRemoteFile","summary":"Upload file to Remote File Manager"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_345","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_345"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"File uploaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}},"schemaId":"schema_347"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"413","description":"File too large (max 50MB)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348"}},"schemaId":"schema_348"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}},"schemaId":"schema_349"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346"}}},{"code":"400","schemaId":"schema_347","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"413","schemaId":"schema_348","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348"}}},{"code":"500","schemaId":"schema_349","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_content/uploadremotefile"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/remote-file/"},{"label":"Generate download URL for existing file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_content/generatedownloadurl","routeSlug":"/openapi/0_content/generatedownloadurl","metadata":{"seo":{"title":"Generate download URL for existing file","description":"Generate a pre-signed download URL for an existing file in REMOTE_FILE_MANAGER bucket"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateDownloadUrl","name":"Generate download URL for existing file","isWebhook":false,"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1generate_download_url~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate download URL for existing file","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a pre-signed download URL for an existing file in REMOTE_FILE_MANAGER bucket"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1generate_download_url~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350","pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1generate_download_url~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/enterprise/{enterprise_id}/content/remote-file/generate_download_url/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_350"}},"responseCodes":["200","400","401","403","500"],"pointer":"/v0/enterprise/{enterprise_id}/content/remote-file/generate_download_url/","href":"0_content/generatedownloadurl","openApiOperationId":"generateDownloadUrl","summary":"Generate download URL for existing file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Download URL generated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}},"schemaId":"schema_351"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}},"schemaId":"schema_352"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353"}],"pointer":"/paths/~1v0~1enterprise~1{enterprise_id}~1content~1remote-file~1generate_download_url~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_351","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351"}}},{"code":"400","schemaId":"schema_352","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_content/generatedownloadurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v0/enterprise/{enterprise_id}/content/remote-file/generate_download_url/"}],"content":{"contentType":"group","meta":{"name":"0_Content"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Content","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage files"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12655910179473","description":"Find out more about Content management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/enterprise/{enterprise_id}/content/","summary":"List content","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_content/getallcontent","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/content/{content_id}/","summary":"Get content information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_content/getcontent","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/content/{content_id}/","summary":"Delete Content","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_content/deletecontent","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/content/{content_id}/","summary":"Patch a content instance","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_content/patchcontent","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/content/upload/","summary":"Upload new content","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_content/postcontent","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/content/remote-file/","summary":"Upload file to Remote File Manager","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_content/uploadremotefile","deprecated":false},{"title":"/v0/enterprise/{enterprise_id}/content/remote-file/generate_download_url/","summary":"Generate download URL for existing file","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_content/generatedownloadurl","deprecated":false}]}]}]}]}},{"type":"group","label":"User (Deprecated)","link":"/openapi/0_user-(deprecated)","routeSlug":"/openapi/0_user-(deprecated)","items":[{"label":"Create a new User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user-(deprecated)/createuser","routeSlug":"/openapi/0_user-(deprecated)/createuser","metadata":{"seo":{"title":"Create a new User","description":"Create a new User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createUser","name":"Create a new User","isWebhook":false,"pointer":"/paths/~1user~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new User","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new User"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"schemaId":"components/schemas/UserCreate","pointer":"/paths/~1user~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"responseCodes":["201","400","401","403","500"],"pointer":"/user/","href":"0_user-(deprecated)/createuser","openApiOperationId":"createUser","summary":"Create a new User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UserCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"User Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1user~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user-(deprecated)/createuser"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/"},{"label":"Update a User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user-(deprecated)/updateuser","routeSlug":"/openapi/0_user-(deprecated)/updateuser","metadata":{"seo":{"title":"Update a User","description":"Update a User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Update a User","isWebhook":false,"pointer":"/paths/~1user~1{user_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a User","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a User"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_302","description":"User ID","required":true}],"pointer":"/paths/~1user~1{user_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"schemaId":"components/schemas/UserCreate","pointer":"/paths/~1user~1{user_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/user/{user_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/user/{user_id}/","href":"0_user-(deprecated)/updateuser","openApiOperationId":"updateUser","summary":"Update a User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UserCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1user~1{user_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user-(deprecated)/updateuser"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/{user_id}/"},{"label":"Partial update a User","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user-(deprecated)/partialupdateuser","routeSlug":"/openapi/0_user-(deprecated)/partialupdateuser","metadata":{"seo":{"title":"Partial update a User","description":"Partial update a User"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialUpdateUser","name":"Partial update a User","isWebhook":false,"pointer":"/paths/~1user~1{user_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial update a User","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partial update a User"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_302","description":"User ID","required":true}],"pointer":"/paths/~1user~1{user_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"schemaId":"components/schemas/UserUpdate","pointer":"/paths/~1user~1{user_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/user/{user_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/user/{user_id}/","href":"0_user-(deprecated)/partialupdateuser","openApiOperationId":"partialUpdateUser","summary":"Partial update a User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UserUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Partial updated User","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1user~1{user_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user-(deprecated)/partialupdateuser"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/{user_id}/"},{"label":"Delete a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user-(deprecated)/userdelete","routeSlug":"/openapi/0_user-(deprecated)/userdelete","metadata":{"seo":{"title":"Delete a user","description":"Delete a user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userDelete","name":"Delete a user","isWebhook":false,"pointer":"/paths/~1user~1{user_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_302","description":"User ID","required":true}],"pointer":"/paths/~1user~1{user_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/user/{user_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/user/{user_id}/","href":"0_user-(deprecated)/userdelete","openApiOperationId":"userDelete","summary":"Delete a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted User"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1user~1{user_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user-(deprecated)/userdelete"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/user/{user_id}/"}],"content":{"contentType":"group","meta":{"name":"0_User (Deprecated)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User (Deprecated)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The following APIs will soon be deprecated. Please transition to the User APIs."},"children":[]}]}]}]},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12656615814929","description":"Find out more about User management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/user/","summary":"Create a new User","prefix":{"name":"post","color":"post"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_user-(deprecated)/createuser","deprecated":false},{"title":"/user/{user_id}/","summary":"Update a User","prefix":{"name":"put","color":"put"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_user-(deprecated)/updateuser","deprecated":false},{"title":"/user/{user_id}/","summary":"Partial update a User","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_user-(deprecated)/partialupdateuser","deprecated":false},{"title":"/user/{user_id}/","summary":"Delete a user","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_user-(deprecated)/userdelete","deprecated":false}]}]}]}]}},{"type":"group","label":"User","link":"/openapi/0_user","routeSlug":"/openapi/0_user","items":[{"label":"User information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/userinfo","routeSlug":"/openapi/0_user/userinfo","metadata":{"seo":{"title":"User information","description":"User information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"userInfo","name":"User information","isWebhook":false,"pointer":"/paths/~1user_info~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"User information"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user_info/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/user_info/","href":"0_user/userinfo","openApiOperationId":"userInfo","summary":"User information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User Info","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1user_info~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/userinfo"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/user_info/"},{"label":"Invite a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/tenantuserinvite","routeSlug":"/openapi/0_user/tenantuserinvite","metadata":{"seo":{"title":"Invite a user","description":"Invite a user to a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tenantUserInvite","name":"Invite a user","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invite a user","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Invite a user to a tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TenantUserInviteRequest"}},"schemaId":"components/schemas/TenantUserInviteRequest","pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authn2/v0/tenant/{enterprise_id}/invite","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TenantUserInviteRequest"}},"responseCodes":["201","400","401"],"pointer":"/authn2/v0/tenant/{enterprise_id}/invite","href":"0_user/tenantuserinvite","openApiOperationId":"tenantUserInvite","summary":"Invite a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/TenantUserInviteRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TenantUserInviteRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Invite sent to user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantUserInviteCreateResponse"}},"schemaId":"components/schemas/TenantUserInviteCreateResponse"},{"code":"400","description":"tenant user invite create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TenantUserInviteCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TenantUserInviteCreateResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/tenantuserinvite"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/invite"},{"label":"List user invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/gettenantuserinvites","routeSlug":"/openapi/0_user/gettenantuserinvites","metadata":{"seo":{"title":"List user invites","description":"List user invites in a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTenantUserInvites","name":"List user invites","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List user invites","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List user invites in a tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authn2/v0/tenant/{enterprise_id}/invite","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["201","400","401"],"pointer":"/authn2/v0/tenant/{enterprise_id}/invite","href":"0_user/gettenantuserinvites","openApiOperationId":"getTenantUserInvites","summary":"List user invites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Tenant user invites","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354"}},"schemaId":"schema_354"},{"code":"400","description":"List tenant user invites error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_354","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_354"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/gettenantuserinvites"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/invite"},{"label":"Delete a invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/deletetenantuserinvite","routeSlug":"/openapi/0_user/deletetenantuserinvite","metadata":{"seo":{"title":"Delete a invite","description":"Delete a invite"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTenantUserInvite","name":"Delete a invite","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite~1{invite_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a invite","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a invite"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"invite_id","in":"path","schemaId":"schema_299","description":"Invite ID","required":true}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite~1{invite_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/authn2/v0/tenant/{enterprise_id}/invite/{invite_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"invite_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401"],"pointer":"/authn2/v0/tenant/{enterprise_id}/invite/{invite_id}","href":"0_user/deletetenantuserinvite","openApiOperationId":"deleteTenantUserInvite","summary":"Delete a invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted tenant user invite"},{"code":"400","description":"Tenant user invite delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1invite~1{invite_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/deletetenantuserinvite"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/invite/{invite_id}"},{"label":"Get Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/getusers","routeSlug":"/openapi/0_user/getusers","metadata":{"seo":{"title":"Get Users","description":"Get a list of users in the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUsers","name":"Get Users","isWebhook":false,"pointer":"/paths/~1user~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Users","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of users in the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/user/","href":"0_user/getusers","openApiOperationId":"getUsers","summary":"Get Users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Users List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}},"schemaId":"schema_355"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1user~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_355","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/getusers"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/user/"},{"label":"Get User Information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/getuser","routeSlug":"/openapi/0_user/getuser","metadata":{"seo":{"title":"Get User Information","description":"Get User Information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Get User Information","isWebhook":false,"pointer":"/paths/~1user~1{user_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get User Information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get User Information"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_302","description":"User ID","required":true}],"pointer":"/paths/~1user~1{user_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/{user_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/user/{user_id}/","href":"0_user/getuser","openApiOperationId":"getUser","summary":"Get User Information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User Details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"401","description":"Authorization information is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1user~1{user_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/getuser"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/user/{user_id}/"},{"label":"Update user role","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/updatedifferentuser","routeSlug":"/openapi/0_user/updatedifferentuser","metadata":{"seo":{"title":"Update user role","description":"Update user's role"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDifferentUser","name":"Update user role","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1users~1{user_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user role","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update user's role"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AuthN User Id. The authn_user_id from the Get Users response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1authz2~1v1~1users~1{user_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDifferentUserRequest"}},"schemaId":"components/schemas/UpdateDifferentUserRequest","pointer":"/paths/~1authz2~1v1~1users~1{user_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authz2/v1/users/{user_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateDifferentUserRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/authz2/v1/users/{user_id}","href":"0_user/updatedifferentuser","openApiOperationId":"updateDifferentUser","summary":"Update user role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateDifferentUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateDifferentUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User Updated Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1users~1{user_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"403","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/updatedifferentuser"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/users/{user_id}"},{"label":"Update user profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/updateownuser","routeSlug":"/openapi/0_user/updateownuser","metadata":{"seo":{"title":"Update user profile","description":"Update user's profile"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOwnUser","name":"Update user profile","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1user~1{user_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user profile","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update user's profile"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"user_id","in":"path","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AuthN User Id. The authn_user_id from the Get Users response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1authn2~1v0~1user~1{user_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOwnUserRequest"}},"schemaId":"components/schemas/UpdateOwnUserRequest","pointer":"/paths/~1authn2~1v0~1user~1{user_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authn2/v0/user/{user_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateOwnUserRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/authn2/v0/user/{user_id}","href":"0_user/updateownuser","openApiOperationId":"updateOwnUser","summary":"Update user profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateOwnUserRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateOwnUserRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User Updated Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1user~1{user_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"403","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/updateownuser"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/user/{user_id}"},{"label":"Get user groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/getusergroups","routeSlug":"/openapi/0_user/getusergroups","metadata":{"seo":{"title":"Get user groups","description":"Get user's groups"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserGroups","name":"Get user groups","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1users~1{user_id}~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user groups","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get user's groups"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AuthN User Id. The authn_user_id from the Get Users response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1authz2~1v1~1users~1{user_id}~1groups/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sub_groups","in":"query","schemaId":"schema_301","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to true to get a list of the user’s subgroup access. Users have access to their group’s subgroups."},"children":[]}]}]}]}],"pointer":"/paths/~1authz2~1v1~1users~1{user_id}~1groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authz2/v1/users/{user_id}/groups","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"sub_groups","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/authz2/v1/users/{user_id}/groups","href":"0_user/getusergroups","openApiOperationId":"getUserGroups","summary":"Get user groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"User Groups","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroups"}},"schemaId":"components/schemas/UserGroups"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1users~1{user_id}~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserGroups","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserGroups"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"403","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/getusergroups"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/users/{user_id}/groups"},{"label":"Delete a user from Enterprise","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/deletetenantuser","routeSlug":"/openapi/0_user/deletetenantuser","metadata":{"seo":{"title":"Delete a user from Enterprise","description":"Delete a user from Enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTenantUser","name":"Delete a user from Enterprise","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1user~1{user_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a user from Enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a user from Enterprise"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"user_id","in":"path","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AuthN User Id. The authn_user_id from the Get Users response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1user~1{user_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/authn2/v0/tenant/{enterprise_id}/user/{user_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401"],"pointer":"/authn2/v0/tenant/{enterprise_id}/user/{user_id}/","href":"0_user/deletetenantuser","openApiOperationId":"deleteTenantUser","summary":"Delete a user from Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted enterprise user"},{"code":"400","description":"Enterprise user delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1user~1{user_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/deletetenantuser"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/user/{user_id}/"},{"label":"Get Users details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_user/paths/~1authn2~1v1~1users~1/get","routeSlug":"/openapi/0_user/paths/~1authn2~1v1~1users~1/get","metadata":{"seo":{"title":"Get Users details","description":"This endpoint allows to fetch user list of a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Users details","isWebhook":false,"pointer":"/paths/~1authn2~1v1~1users~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Users details","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows to fetch user list of a tenant\n"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"legacy_user_id","in":"query","schemaId":"schema_302","description":"Legacy User ID"}],"pointer":"/paths/~1authn2~1v1~1users~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authn2/v1/users/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"legacy_user_id","in":"query","required":false,"schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/authn2/v1/users/","href":"0_user/paths/~1authn2~1v1~1users~1/get","summary":"Get Users details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Users fetched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsersListResponse"}},"schemaId":"components/schemas/UsersListResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v1~1users~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UsersListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsersListResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_user/paths/~1authn2~1v1~1users~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v1/users/"}],"content":{"contentType":"group","meta":{"name":"0_User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true},{"nodeType":"markdoc","content":"APIs for User Management"},{"nodeType":"external-docs","url":"https://help.esper.io/hc/en-us/articles/12656615814929","description":"Find out more about User management"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/user_info/","summary":"User information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/userinfo","deprecated":false},{"title":"/authn2/v0/tenant/{enterprise_id}/invite","summary":"Invite a user","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/tenantuserinvite","deprecated":false},{"title":"/authn2/v0/tenant/{enterprise_id}/invite","summary":"List user invites","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/gettenantuserinvites","deprecated":false},{"title":"/authn2/v0/tenant/{enterprise_id}/invite/{invite_id}","summary":"Delete a invite","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/deletetenantuserinvite","deprecated":false},{"title":"/user/","summary":"Get Users","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/getusers","deprecated":false},{"title":"/user/{user_id}/","summary":"Get User Information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/getuser","deprecated":false},{"title":"/authz2/v1/users/{user_id}","summary":"Update user role","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/updatedifferentuser","deprecated":false},{"title":"/authn2/v0/user/{user_id}","summary":"Update user profile","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/updateownuser","deprecated":false},{"title":"/authz2/v1/users/{user_id}/groups","summary":"Get user groups","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/getusergroups","deprecated":false},{"title":"/authn2/v0/tenant/{enterprise_id}/user/{user_id}/","summary":"Delete a user from Enterprise","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/deletetenantuser","deprecated":false},{"title":"/authn2/v1/users/","summary":"Get Users details","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_user/paths/~1authn2~1v1~1users~1/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Blueprint (Deprecated)","link":"/openapi/0_blueprint-(deprecated)","routeSlug":"/openapi/0_blueprint-(deprecated)","items":[{"label":"Get list of Blueprints for the group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/listblueprint","routeSlug":"/openapi/0_blueprint-(deprecated)/listblueprint","metadata":{"seo":{"title":"Get list of Blueprints for the group","description":"Return list of Blueprint instances for the group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBlueprint","name":"Get list of Blueprints for the group","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of Blueprints for the group","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return list of Blueprint instances for the group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/","href":"0_blueprint-(deprecated)/listblueprint","openApiOperationId":"listBlueprint","summary":"Get list of Blueprints for the group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blueprint detail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}},{"code":"default","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/listblueprint"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/"},{"label":"Create a Blueprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/createblueprint","routeSlug":"/openapi/0_blueprint-(deprecated)/createblueprint","metadata":{"seo":{"title":"Create a Blueprint","description":"Returns the created Blueprint instance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBlueprint","name":"Create a Blueprint","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Blueprint","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the created Blueprint instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"schemaId":"components/schemas/Blueprint","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"responseCodes":["201","400","401"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/","href":"0_blueprint-(deprecated)/createblueprint","openApiOperationId":"createBlueprint","summary":"Create a Blueprint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Blueprint","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"schemaId":"components/schemas/Blueprint"},{"code":"400","description":"Blueprint create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Blueprint create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Blueprint","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/createblueprint"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/"},{"label":"Get Blueprint detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/getblueprint","routeSlug":"/openapi/0_blueprint-(deprecated)/getblueprint","metadata":{"seo":{"title":"Get Blueprint detail","description":"Returns the details of a Blueprint instance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBlueprint","name":"Get Blueprint detail","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Blueprint detail","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the details of a Blueprint instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true},{"name":"blueprint_id","in":"path","schemaId":"schema_299","description":"Blueprint ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","href":"0_blueprint-(deprecated)/getblueprint","openApiOperationId":"getBlueprint","summary":"Get Blueprint detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blueprint detail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"schemaId":"components/schemas/Blueprint"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Blueprint","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}}},{"code":"default","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/getblueprint"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/"},{"label":"Partial update a Blueprint","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/partialupdateblueprint","routeSlug":"/openapi/0_blueprint-(deprecated)/partialupdateblueprint","metadata":{"seo":{"title":"Partial update a Blueprint","description":"Returns the details of the updated Blueprint instance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"partialUpdateBlueprint","name":"Partial update a Blueprint","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partial update a Blueprint","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the details of the updated Blueprint instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true},{"name":"blueprint_id","in":"path","schemaId":"schema_299","description":"Blueprint ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"schemaId":"components/schemas/Blueprint","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"responseCodes":["200","400","401"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","href":"0_blueprint-(deprecated)/partialupdateblueprint","openApiOperationId":"partialUpdateBlueprint","summary":"Partial update a Blueprint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Blueprint","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Partially updated Blueprint","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"schemaId":"components/schemas/Blueprint"},{"code":"400","description":"Blueprint update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Blueprint update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Blueprint","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/partialupdateblueprint"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/"},{"label":"Delete a Blueprint","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/deleteblueprint","routeSlug":"/openapi/0_blueprint-(deprecated)/deleteblueprint","metadata":{"seo":{"title":"Delete a Blueprint","description":"Deletes the requested Blueprint instance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBlueprint","name":"Delete a Blueprint","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Blueprint","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the requested Blueprint instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true},{"name":"blueprint_id","in":"path","schemaId":"schema_299","description":"Blueprint ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","href":"0_blueprint-(deprecated)/deleteblueprint","openApiOperationId":"deleteBlueprint","summary":"Delete a Blueprint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted Blueprint"},{"code":"401","description":"Blueprint delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/deleteblueprint"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/"},{"label":"Get list of Blueprint Revisions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/listblueprintrevisions","routeSlug":"/openapi/0_blueprint-(deprecated)/listblueprintrevisions","metadata":{"seo":{"title":"Get list of Blueprint Revisions","description":"Returns a list of Blueprint Revisions instances for the given Blueprint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBlueprintRevisions","name":"Get list of Blueprint Revisions","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of Blueprint Revisions","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of Blueprint Revisions instances for the given Blueprint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true},{"name":"blueprint_id","in":"path","schemaId":"schema_299","description":"Blueprint ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/","href":"0_blueprint-(deprecated)/listblueprintrevisions","openApiOperationId":"listBlueprintRevisions","summary":"Get list of Blueprint Revisions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blueprint revision list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}},"schemaId":"schema_357"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_357","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}}},{"code":"default","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/listblueprintrevisions"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/"},{"label":"Get Blueprint Revision detail","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/getblueprintrevision","routeSlug":"/openapi/0_blueprint-(deprecated)/getblueprintrevision","metadata":{"seo":{"title":"Get Blueprint Revision detail","description":"Returns the detail of Blueprint Revision instance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBlueprintRevision","name":"Get Blueprint Revision detail","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1{revision_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Blueprint Revision detail","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the detail of Blueprint Revision instance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true},{"name":"blueprint_id","in":"path","schemaId":"schema_299","description":"Blueprint ID","required":true},{"name":"revision_id","in":"path","schemaId":"schema_299","description":"Blueprint Revision ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1{revision_id}~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1{revision_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/{revision_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"revision_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"without_details","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/{revision_id}/","href":"0_blueprint-(deprecated)/getblueprintrevision","openApiOperationId":"getBlueprintRevision","summary":"Get Blueprint Revision detail"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Blueprint revision detail","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlueprintRevision"}},"schemaId":"components/schemas/BlueprintRevision"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1{blueprint_id}~1revisions~1{revision_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BlueprintRevision","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BlueprintRevision"}}},{"code":"default","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/getblueprintrevision"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/{revision_id}/"},{"label":"Restore a Blueprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/restoreblueprintrevision","routeSlug":"/openapi/0_blueprint-(deprecated)/restoreblueprintrevision","metadata":{"seo":{"title":"Restore a Blueprint","description":"Returns the Blueprint instance restored to the requested Blueprint Revision."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"restoreBlueprintRevision","name":"Restore a Blueprint","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1restore~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restore a Blueprint","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the Blueprint instance restored to the requested Blueprint Revision."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1restore~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1restore~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/restore/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_358"}},"responseCodes":["201","400","401"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/restore/","href":"0_blueprint-(deprecated)/restoreblueprintrevision","openApiOperationId":"restoreBlueprintRevision","summary":"Restore a Blueprint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Restored","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"schemaId":"components/schemas/Blueprint"},{"code":"400","description":"Blueprint restore error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Blueprint restore error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1restore~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Blueprint","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/restoreblueprintrevision"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/restore/"},{"label":"Upload a Blueprint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_blueprint-(deprecated)/uploadblueprint","routeSlug":"/openapi/0_blueprint-(deprecated)/uploadblueprint","metadata":{"seo":{"title":"Upload a Blueprint","description":"Create a Blueprint by uploading a json file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadBlueprint","name":"Upload a Blueprint","isWebhook":false,"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1upload~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a Blueprint","badges":[{"name":"Deprecated","color":"red"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Blueprint by uploading a json file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"group_id","in":"path","schemaId":"schema_299","description":"Device Group ID","required":true}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1upload~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_359"}},"schemaId":"schema_359","pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1upload~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/upload/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"group_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_359"}},"responseCodes":["201","400","401"],"pointer":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/upload/","href":"0_blueprint-(deprecated)/uploadblueprint","openApiOperationId":"uploadBlueprint","summary":"Upload a Blueprint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_359","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_359"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Uploaded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}},"schemaId":"components/schemas/Blueprint"},{"code":"400","description":"Blueprint upload error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Blueprint upload error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1{enterprise_id}~1devicegroup~1{group_id}~1blueprint~1upload~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Blueprint","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Blueprint"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_blueprint-(deprecated)/uploadblueprint"}],"panels":[]}]},"badges":[{"name":"Deprecated","color":"red"}],"httpPath":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/upload/"}],"content":{"contentType":"group","meta":{"name":"0_Blueprint (Deprecated)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blueprint (Deprecated)","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the API for the former Blueprints service."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"⚠️ "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecation Notice:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The following APIs will soon be deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Blueprints-API"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blueprints API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/","summary":"Get list of Blueprints for the group","prefix":{"name":"get","color":"get"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/listblueprint","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/","summary":"Create a Blueprint","prefix":{"name":"post","color":"post"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/createblueprint","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","summary":"Get Blueprint detail","prefix":{"name":"get","color":"get"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/getblueprint","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","summary":"Partial update a Blueprint","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/partialupdateblueprint","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/","summary":"Delete a Blueprint","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/deleteblueprint","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/","summary":"Get list of Blueprint Revisions","prefix":{"name":"get","color":"get"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/listblueprintrevisions","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/{blueprint_id}/revisions/{revision_id}/","summary":"Get Blueprint Revision detail","prefix":{"name":"get","color":"get"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/getblueprintrevision","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/restore/","summary":"Restore a Blueprint","prefix":{"name":"post","color":"post"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/restoreblueprintrevision","deprecated":false},{"title":"/enterprise/{enterprise_id}/devicegroup/{group_id}/blueprint/upload/","summary":"Upload a Blueprint","prefix":{"name":"post","color":"post"},"badges":[{"name":"Deprecated","color":"red"}],"link":"/0_blueprint-(deprecated)/uploadblueprint","deprecated":false}]}]}]}]}},{"type":"group","label":"Directory Record","link":"/openapi/0_directory-record","routeSlug":"/openapi/0_directory-record","items":[{"label":"Get all Directory Records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_directory-record/getdirectoryrecords","routeSlug":"/openapi/0_directory-record/getdirectoryrecords","metadata":{"seo":{"title":"Get all Directory Records","description":"Returns a list of all Directory Record instances"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDirectoryRecords","name":"Get all Directory Records","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Directory Records","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all Directory Record instances"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/directory_record/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/enterprise/{enterprise_id}/directory_record/","href":"0_directory-record/getdirectoryrecords","openApiOperationId":"getDirectoryRecords","summary":"Get all Directory Records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Directory records","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}}},{"code":"default","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_directory-record/getdirectoryrecords"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/"},{"label":"Create a new Directory Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_directory-record/createdirectoryrecord","routeSlug":"/openapi/0_directory-record/createdirectoryrecord","metadata":{"seo":{"title":"Create a new Directory Record","description":"Returns the created Directory Record intance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDirectoryRecord","name":"Create a new Directory Record","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Directory Record","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the created Directory Record intance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryRecordCreate"}},"schemaId":"components/schemas/DirectoryRecordCreate","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/enterprise/{enterprise_id}/directory_record/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectoryRecordCreate"}},"responseCodes":["201","400","401"],"pointer":"/v1/enterprise/{enterprise_id}/directory_record/","href":"0_directory-record/createdirectoryrecord","openApiOperationId":"createDirectoryRecord","summary":"Create a new Directory Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/DirectoryRecordCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryRecordCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectoryRecord"}},"schemaId":"components/schemas/DirectoryRecord"},{"code":"400","description":"Directory record create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Directory record create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DirectoryRecord","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectoryRecord"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_directory-record/createdirectoryrecord"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/"},{"label":"Get details about a Directory Record","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_directory-record/getdirectoryrecord","routeSlug":"/openapi/0_directory-record/getdirectoryrecord","metadata":{"seo":{"title":"Get details about a Directory Record","description":"Returns detail of the Directory Record instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDirectoryRecord","name":"Get details about a Directory Record","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details about a Directory Record","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns detail of the Directory Record instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"directory_record_id","in":"path","schemaId":"schema_299","description":"Directory record ID","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"directory_record_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","href":"0_directory-record/getdirectoryrecord","openApiOperationId":"getDirectoryRecord","summary":"Get details about a Directory Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Directory record information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectoryRecord"}},"schemaId":"components/schemas/DirectoryRecord"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectoryRecord","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectoryRecord"}}},{"code":"default","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_directory-record/getdirectoryrecord"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/"},{"label":"Update a Directory Record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_directory-record/updatedirectoryrecord","routeSlug":"/openapi/0_directory-record/updatedirectoryrecord","metadata":{"seo":{"title":"Update a Directory Record","description":"Returns the updated Directory Record instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDirectoryRecord","name":"Update a Directory Record","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Directory Record","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the updated Directory Record instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"directory_record_id","in":"path","schemaId":"schema_299","description":"Directory record ID","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryRecordUpdate"}},"schemaId":"components/schemas/DirectoryRecordUpdate","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"directory_record_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DirectoryRecordUpdate"}},"responseCodes":["200","400","401"],"pointer":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","href":"0_directory-record/updatedirectoryrecord","openApiOperationId":"updateDirectoryRecord","summary":"Update a Directory Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/DirectoryRecordUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DirectoryRecordUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Directory Record Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectoryRecord"}},"schemaId":"components/schemas/DirectoryRecord"},{"code":"400","description":"Directory record update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Directory record update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DirectoryRecord","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DirectoryRecord"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_directory-record/updatedirectoryrecord"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/"},{"label":"Delete a Directory Record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_directory-record/deletedirectoryrecord","routeSlug":"/openapi/0_directory-record/deletedirectoryrecord","metadata":{"seo":{"title":"Delete a Directory Record","description":"Deletes the requested Directory Record instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDirectoryRecord","name":"Delete a Directory Record","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Directory Record","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the requested Directory Record instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"directory_record_id","in":"path","schemaId":"schema_299","description":"Directory record ID","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"directory_record_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401"],"pointer":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","href":"0_directory-record/deletedirectoryrecord","openApiOperationId":"deleteDirectoryRecord","summary":"Delete a Directory Record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted Directory Record"},{"code":"401","description":"Directory record delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1directory_record~1{directory_record_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_directory-record/deletedirectoryrecord"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/"}],"content":{"contentType":"group","meta":{"name":"0_Directory Record"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Directory Record","showPageActions":true},{"nodeType":"markdoc","content":"APIs for Directory Record management. These APIs are only available to the customers using the new Onboarding experience."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/directory_record/","summary":"Get all Directory Records","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_directory-record/getdirectoryrecords","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/directory_record/","summary":"Create a new Directory Record","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_directory-record/createdirectoryrecord","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","summary":"Get details about a Directory Record","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_directory-record/getdirectoryrecord","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","summary":"Update a Directory Record","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_directory-record/updatedirectoryrecord","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/","summary":"Delete a Directory Record","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_directory-record/deletedirectoryrecord","deprecated":false}]}]}]}]}},{"type":"group","label":"Tile Icon","link":"/openapi/0_tile-icon","routeSlug":"/openapi/0_tile-icon","items":[{"label":"Get List of Device Tile Icons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_tile-icon/gettileicons","routeSlug":"/openapi/0_tile-icon/gettileicons","metadata":{"seo":{"title":"Get List of Device Tile Icons","description":"Returns list of tile icons"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTileIcons","name":"Get List of Device Tile Icons","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get List of Device Tile Icons","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of tile icons"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"Filter tile icons created after a given timestamp."},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"Filter tile icons created before a given timestamp."},{"name":"updated_on_gt","in":"query","schemaId":"schema_304","description":"Filter tile icons updated after a given timestamp."},{"name":"updated_on_lt","in":"query","schemaId":"schema_304","description":"Filter tile icons updated before a given timestamp."},{"name":"category","in":"query","schemaId":"schema_300","description":"Filter tile icons by category."},{"name":"device_model","in":"query","schemaId":"schema_300","description":"Filter tile icons by device model."},{"name":"custom","in":"query","schemaId":"schema_301","description":"Filter custom tile icons."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/tile-icons/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304"},{"name":"category","in":"query","schemaId":"schema_300"},{"name":"device_model","in":"query","schemaId":"schema_300"},{"name":"custom","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/tile-icons/","href":"0_tile-icon/gettileicons","openApiOperationId":"getTileIcons","summary":"Get List of Device Tile Icons"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_tile-icon/gettileicons"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/"},{"label":"Create a  tile icon","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_tile-icon/addtileicon","routeSlug":"/openapi/0_tile-icon/addtileicon","metadata":{"seo":{"title":"Create a  tile icon","description":"Create a tile icon."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addTileIcon","name":"Create a  tile icon","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a  tile icon","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a tile icon."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_362"}},"schemaId":"schema_362","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/enterprise/{enterprise_id}/tile-icons/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_362"}},"responseCodes":["201","400","401","403","415","500"],"pointer":"/v1/enterprise/{enterprise_id}/tile-icons/","href":"0_tile-icon/addtileicon","openApiOperationId":"addTileIcon","summary":"Create a  tile icon"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_362","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_362"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TileIcon"}},"schemaId":"components/schemas/TileIcon"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/TileIcon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TileIcon"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_tile-icon/addtileicon"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/"},{"label":"Get instance of a tile icon","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_tile-icon/gettileicon","routeSlug":"/openapi/0_tile-icon/gettileicon","metadata":{"seo":{"title":"Get instance of a tile icon","description":"Get a tile icon."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTileIcon","name":"Get instance of a tile icon","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1{tileicons_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instance of a tile icon","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a tile icon."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"tileicons_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the tile icon.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1{tileicons_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"tileicons_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/","href":"0_tile-icon/gettileicon","openApiOperationId":"getTileIcon","summary":"Get instance of a tile icon"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TileIcon"}},"schemaId":"components/schemas/TileIcon"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1{tileicons_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TileIcon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TileIcon"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_tile-icon/gettileicon"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/"},{"label":"Delete a tile icon","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_tile-icon/deletetileicon","routeSlug":"/openapi/0_tile-icon/deletetileicon","metadata":{"seo":{"title":"Delete a tile icon","description":"Deletes a title icon"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTileIcon","name":"Delete a tile icon","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1{tileicons_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a tile icon","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a title icon"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"tileicons_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the tile icon.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1{tileicons_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"tileicons_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/","href":"0_tile-icon/deletetileicon","openApiOperationId":"deleteTileIcon","summary":"Delete a tile icon"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icons~1{tileicons_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_tile-icon/deletetileicon"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/"},{"label":"Set a tile icon for a device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_tile-icon/applytileicon","routeSlug":"/openapi/0_tile-icon/applytileicon","metadata":{"seo":{"title":"Set a tile icon for a device","description":"Apply a tile icon to a device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyTileIcon","name":"Set a tile icon for a device","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-apply~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a tile icon for a device","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Apply a tile icon to a device."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-apply~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyTileIcon"}},"schemaId":"components/schemas/ApplyTileIcon","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-apply~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/enterprise/{enterprise_id}/tile-icon-apply/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyTileIcon"}},"responseCodes":["201","400","401","403","500"],"pointer":"/v1/enterprise/{enterprise_id}/tile-icon-apply/","href":"0_tile-icon/applytileicon","openApiOperationId":"applyTileIcon","summary":"Set a tile icon for a device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/ApplyTileIcon","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyTileIcon"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyTileIcon"}},"schemaId":"components/schemas/ApplyTileIcon"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-apply~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ApplyTileIcon","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyTileIcon"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_tile-icon/applytileicon"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icon-apply/"},{"label":"Removes tile icon for device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_tile-icon/removetileicon","routeSlug":"/openapi/0_tile-icon/removetileicon","metadata":{"seo":{"title":"Removes tile icon for device","description":"Returns the model of the device(s)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeTileIcon","name":"Removes tile icon for device","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-unapply~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes tile icon for device","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the model of the device(s)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-unapply~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-unapply~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/enterprise/{enterprise_id}/tile-icon-unapply/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_363"}},"responseCodes":["201","400","401","403","500"],"pointer":"/v1/enterprise/{enterprise_id}/tile-icon-unapply/","href":"0_tile-icon/removetileicon","openApiOperationId":"removeTileIcon","summary":"Removes tile icon for device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_363"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1tile-icon-unapply~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_tile-icon/removetileicon"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/tile-icon-unapply/"}],"content":{"contentType":"group","meta":{"name":"0_Tile Icon"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tile Icon","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage tile icons. Tile icons allow Templates-based users to apply a icons to devices."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/tile-icons/","summary":"Get List of Device Tile Icons","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_tile-icon/gettileicons","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/tile-icons/","summary":"Create a  tile icon","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_tile-icon/addtileicon","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/","summary":"Get instance of a tile icon","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_tile-icon/gettileicon","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/tile-icons/{tileicons_id}/","summary":"Delete a tile icon","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_tile-icon/deletetileicon","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/tile-icon-apply/","summary":"Set a tile icon for a device","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_tile-icon/applytileicon","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/tile-icon-unapply/","summary":"Removes tile icon for device","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_tile-icon/removetileicon","deprecated":false}]}]}]}]}},{"type":"group","label":"Alerts","link":"/openapi/0_alerts","routeSlug":"/openapi/0_alerts","items":[{"label":"List alert channels in enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alerts/listalertchannels","routeSlug":"/openapi/0_alerts/listalertchannels","metadata":{"seo":{"title":"List alert channels in enterprise","description":"Returns list of alert channels"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAlertChannels","name":"List alert channels in enterprise","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List alert channels in enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of alert channels"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_300","description":"Filter alert channels by name."},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/alertchannels/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"name","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alertchannels/","href":"0_alerts/listalertchannels","openApiOperationId":"listAlertChannels","summary":"List alert channels in enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alerts/listalertchannels"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/"},{"label":"Creates alert channel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alerts/createalertchannel","routeSlug":"/openapi/0_alerts/createalertchannel","metadata":{"seo":{"title":"Creates alert channel","description":"Returns instance of alert channel"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAlertChannel","name":"Creates alert channel","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates alert channel","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of alert channel"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"schemaId":"components/schemas/UpdateAlertChannelsV1","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/enterprise/{enterprise_id}/alertchannels/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"responseCodes":["201","400","401","403","500"],"pointer":"/v1/enterprise/{enterprise_id}/alertchannels/","href":"0_alerts/createalertchannel","openApiOperationId":"createAlertChannel","summary":"Creates alert channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateAlertChannelsV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}},"schemaId":"components/schemas/AlertChannelsV1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AlertChannelsV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alerts/createalertchannel"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/"},{"label":"Get alert channel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alerts/getalertchannel","routeSlug":"/openapi/0_alerts/getalertchannel","metadata":{"seo":{"title":"Get alert channel","description":"Returns instance of alert channel"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlertChannel","name":"Get alert channel","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get alert channel","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of alert channel"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"alert_id","in":"path","schemaId":"schema_302","description":"An integer identifying the alert channel.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"alert_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","href":"0_alerts/getalertchannel","openApiOperationId":"getAlertChannel","summary":"Get alert channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}},"schemaId":"components/schemas/AlertChannelsV1"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlertChannelsV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alerts/getalertchannel"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"},{"label":"Update alert channel information","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alerts/updatealertchannel","routeSlug":"/openapi/0_alerts/updatealertchannel","metadata":{"seo":{"title":"Update alert channel information","description":"Returns alert channel instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAlertChannel","name":"Update alert channel information","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update alert channel information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns alert channel instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true},{"name":"alert_id","in":"path","schemaId":"schema_302","description":"An integer identifying the alert channel.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"schemaId":"components/schemas/UpdateAlertChannelsV1","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"alert_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","href":"0_alerts/updatealertchannel","openApiOperationId":"updateAlertChannel","summary":"Update alert channel information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateAlertChannelsV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}},"schemaId":"components/schemas/AlertChannelsV1"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlertChannelsV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alerts/updatealertchannel"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"},{"label":"Partially updates alert channel information","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alerts/patchalertchannel","routeSlug":"/openapi/0_alerts/patchalertchannel","metadata":{"seo":{"title":"Partially updates alert channel information","description":"Returns alert channel instance"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAlertChannel","name":"Partially updates alert channel information","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates alert channel information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns alert channel instance"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true},{"name":"alert_id","in":"path","schemaId":"schema_302","description":"An integer identifying the alert channel.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"schemaId":"components/schemas/UpdateAlertChannelsV1","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"alert_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","href":"0_alerts/patchalertchannel","openApiOperationId":"patchAlertChannel","summary":"Partially updates alert channel information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateAlertChannelsV1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlertChannelsV1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}},"schemaId":"components/schemas/AlertChannelsV1"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlertChannelsV1","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertChannelsV1"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alerts/patchalertchannel"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"},{"label":"Delete an alert channel","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alerts/deletealertchannel","routeSlug":"/openapi/0_alerts/deletealertchannel","metadata":{"seo":{"title":"Delete an alert channel","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAlertChannel","name":"Delete an alert channel","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an alert channel","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"A UUID string identifying the enterprise.","required":true},{"name":"alert_id","in":"path","schemaId":"schema_302","description":"An integer identifying the alert channel.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"alert_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","href":"0_alerts/deletealertchannel","openApiOperationId":"deleteAlertChannel","summary":"Delete an alert channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alertchannels~1{alert_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alerts/deletealertchannel"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}"}],"content":{"contentType":"group","meta":{"name":"0_Alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alerts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/alertchannels/","summary":"List alert channels in enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alerts/listalertchannels","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alertchannels/","summary":"Creates alert channel","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alerts/createalertchannel","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","summary":"Get alert channel","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alerts/getalertchannel","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","summary":"Update alert channel information","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alerts/updatealertchannel","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","summary":"Partially updates alert channel information","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alerts/patchalertchannel","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}","summary":"Delete an alert channel","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alerts/deletealertchannel","deprecated":false}]}]}]}]}},{"type":"group","label":"Alarms","link":"/openapi/0_alarms","routeSlug":"/openapi/0_alarms","items":[{"label":"Get list of alarm rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alarms/getalarmrules","routeSlug":"/openapi/0_alarms/getalarmrules","metadata":{"seo":{"title":"Get list of alarm rules","description":"Returns list of alarm rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlarmRules","name":"Get list of alarm rules","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of alarm rules","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of alarm rules"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_300","description":"Filter alarm rules by name."},{"name":"description","in":"query","schemaId":"schema_300","description":"Filter alarm rules by description."},{"name":"is_active","in":"query","schemaId":"schema_301","description":"Filter active alarm rules."},{"name":"created_on_gt","in":"query","schemaId":"schema_300","description":"Filter alarm rules created after a given timestamp."},{"name":"created_on_lt","in":"query","schemaId":"schema_300","description":"Filter alarm rules created before a given timestamp."},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/alarmrules/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"name","in":"query","schemaId":"schema_300"},{"name":"description","in":"query","schemaId":"schema_300"},{"name":"is_active","in":"query","schemaId":"schema_301"},{"name":"created_on_gt","in":"query","schemaId":"schema_300"},{"name":"created_on_lt","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alarmrules/","href":"0_alarms/getalarmrules","openApiOperationId":"getAlarmRules","summary":"Get list of alarm rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alarms/getalarmrules"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/"},{"label":"Creates instance of alarm rules","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alarms/addalarmrule","routeSlug":"/openapi/0_alarms/addalarmrule","metadata":{"seo":{"title":"Creates instance of alarm rules","description":"Returns instance of alarm rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addAlarmRule","name":"Creates instance of alarm rules","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates instance of alarm rules","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of alarm rules"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"schemaId":"components/schemas/UpdateAlarmRule","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/enterprise/{enterprise_id}/alarmrules/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"responseCodes":["201","400","401","403","500"],"pointer":"/v1/enterprise/{enterprise_id}/alarmrules/","href":"0_alarms/addalarmrule","openApiOperationId":"addAlarmRule","summary":"Creates instance of alarm rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateAlarmRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}},"schemaId":"components/schemas/AlarmRule"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AlarmRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alarms/addalarmrule"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/"},{"label":"Get instance of alarm rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alarms/getalarmrule","routeSlug":"/openapi/0_alarms/getalarmrule","metadata":{"seo":{"title":"Get instance of alarm rule","description":"Returns instance of alarm rule"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlarmRule","name":"Get instance of alarm rule","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instance of alarm rule","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of alarm rule"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"alarm_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the alarm ruleset.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"alarm_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","href":"0_alarms/getalarmrule","openApiOperationId":"getAlarmRule","summary":"Get instance of alarm rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}},"schemaId":"components/schemas/AlarmRule"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlarmRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alarms/getalarmrule"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Update alarm rules","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alarms/updatealarmrule","routeSlug":"/openapi/0_alarms/updatealarmrule","metadata":{"seo":{"title":"Update alarm rules","description":"Return instance of alarm rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAlarmRule","name":"Update alarm rules","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update alarm rules","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Return instance of alarm rules"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"alarm_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the alarm ruleset.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"schemaId":"components/schemas/UpdateAlarmRule","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"alarm_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","href":"0_alarms/updatealarmrule","openApiOperationId":"updateAlarmRule","summary":"Update alarm rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateAlarmRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}},"schemaId":"components/schemas/AlarmRule"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlarmRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alarms/updatealarmrule"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Partially updates alarm rules","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alarms/patchalarmrule","routeSlug":"/openapi/0_alarms/patchalarmrule","metadata":{"seo":{"title":"Partially updates alarm rules","description":"Returns instance of alarm rules"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAlarmRule","name":"Partially updates alarm rules","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates alarm rules","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of alarm rules"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"alarm_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the alarm ruleset.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"schemaId":"components/schemas/UpdateAlarmRule","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"alarm_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","href":"0_alarms/patchalarmrule","openApiOperationId":"patchAlarmRule","summary":"Partially updates alarm rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/UpdateAlarmRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAlarmRule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}},"schemaId":"components/schemas/AlarmRule"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlarmRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmRule"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alarms/patchalarmrule"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Deletes alarm rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alarms/deletealarmrule","routeSlug":"/openapi/0_alarms/deletealarmrule","metadata":{"seo":{"title":"Deletes alarm rule","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAlarmRule","name":"Deletes alarm rule","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes alarm rule","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"alarm_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the alarm ruleset.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"alarm_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","href":"0_alarms/deletealarmrule","openApiOperationId":"deleteAlarmRule","summary":"Deletes alarm rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alarms/deletealarmrule"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/"},{"label":"Get history of alarm rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_alarms/getalarmhistory","routeSlug":"/openapi/0_alarms/getalarmhistory","metadata":{"seo":{"title":"Get history of alarm rule","description":"Returns instance of alarm rule history"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlarmHistory","name":"Get history of alarm rule","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1alarmhistory~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get history of alarm rule","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of alarm rule history"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"alarm_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the alarm ruleset.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1alarmhistory~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/alarmhistory/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"alarm_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/alarmhistory/","href":"0_alarms/getalarmhistory","openApiOperationId":"getAlarmHistory","summary":"Get history of alarm rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmHistory"}},"schemaId":"components/schemas/AlarmHistory"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1alarmrules~1{alarm_id}~1alarmhistory~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlarmHistory","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmHistory"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_alarms/getalarmhistory"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/alarmhistory/"}],"content":{"contentType":"group","meta":{"name":"0_Alarms"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alarms","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/alarmrules/","summary":"Get list of alarm rules","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alarms/getalarmrules","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alarmrules/","summary":"Creates instance of alarm rules","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alarms/addalarmrule","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","summary":"Get instance of alarm rule","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alarms/getalarmrule","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","summary":"Update alarm rules","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alarms/updatealarmrule","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","summary":"Partially updates alarm rules","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alarms/patchalarmrule","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/","summary":"Deletes alarm rule","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alarms/deletealarmrule","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/alarmhistory/","summary":"Get history of alarm rule","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_alarms/getalarmhistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Wallpapers","link":"/openapi/0_wallpapers","routeSlug":"/openapi/0_wallpapers","items":[{"label":"Get list of wallpapers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_wallpapers/getwallpapers","routeSlug":"/openapi/0_wallpapers/getwallpapers","metadata":{"seo":{"title":"Get list of wallpapers","description":"Returns list of wallpapers"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWallpapers","name":"Get list of wallpapers","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of wallpapers","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of wallpapers"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"Filter applications created after a given timestamp."},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"Filter applications created before a given timestamp."},{"name":"updated_on_gt","in":"query","schemaId":"schema_304","description":"Filter applications updated after a given timestamp."},{"name":"updated_on_lt","in":"query","schemaId":"schema_304","description":"Filter applications updated before a given timestamp."},{"name":"limit","in":"query","schemaId":"schema_305","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_306","description":"Return results from this index."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/wallpaper/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304"},{"name":"limit","in":"query","schemaId":"schema_305"},{"name":"offset","in":"query","schemaId":"schema_306"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/wallpaper/","href":"0_wallpapers/getwallpapers","openApiOperationId":"getWallpapers","summary":"Get list of wallpapers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_wallpapers/getwallpapers"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/"},{"label":"Create wallpaper","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_wallpapers/addwallpaper","routeSlug":"/openapi/0_wallpapers/addwallpaper","metadata":{"seo":{"title":"Create wallpaper","description":"Returns instance of created wallpaper"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addWallpaper","name":"Create wallpaper","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create wallpaper","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of created wallpaper"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_368"}},"schemaId":"schema_368","pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/enterprise/{enterprise_id}/wallpaper/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_368"}},"responseCodes":["201","400","401","403","415","500"],"pointer":"/v1/enterprise/{enterprise_id}/wallpaper/","href":"0_wallpapers/addwallpaper","openApiOperationId":"addWallpaper","summary":"Create wallpaper"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_368","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_368"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Wallpaper"}},"schemaId":"components/schemas/Wallpaper"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"415","description":"Unsupported media type.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Wallpaper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Wallpaper"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"415","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_wallpapers/addwallpaper"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/"},{"label":"Get instance of wallpaper","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_wallpapers/getwallpaper","routeSlug":"/openapi/0_wallpapers/getwallpaper","metadata":{"seo":{"title":"Get instance of wallpaper","description":"Returns instance of wallpaper"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWallpaper","name":"Get instance of wallpaper","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1{wallpaper_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instance of wallpaper","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of wallpaper"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"wallpaper_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the wallpaper.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1{wallpaper_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"wallpaper_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/","href":"0_wallpapers/getwallpaper","openApiOperationId":"getWallpaper","summary":"Get instance of wallpaper"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Wallpaper"}},"schemaId":"components/schemas/Wallpaper"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1{wallpaper_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Wallpaper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Wallpaper"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_wallpapers/getwallpaper"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/"},{"label":"Deletes instance of wallpaper","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_wallpapers/deletewallpaper","routeSlug":"/openapi/0_wallpapers/deletewallpaper","metadata":{"seo":{"title":"Deletes instance of wallpaper","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWallpaper","name":"Deletes instance of wallpaper","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1{wallpaper_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes instance of wallpaper","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"wallpaper_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying the wallpaper.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1{wallpaper_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"wallpaper_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/","href":"0_wallpapers/deletewallpaper","openApiOperationId":"deleteWallpaper","summary":"Deletes instance of wallpaper"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1wallpaper~1{wallpaper_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_wallpapers/deletewallpaper"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/"}],"content":{"contentType":"group","meta":{"name":"0_Wallpapers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wallpapers","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/wallpaper/","summary":"Get list of wallpapers","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_wallpapers/getwallpapers","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/wallpaper/","summary":"Create wallpaper","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_wallpapers/addwallpaper","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/","summary":"Get instance of wallpaper","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_wallpapers/getwallpaper","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/wallpaper/{wallpaper_id}/","summary":"Deletes instance of wallpaper","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_wallpapers/deletewallpaper","deprecated":false}]}]}]}]}},{"type":"group","label":"Device Telemetry","link":"/openapi/0_device-telemetry","routeSlug":"/openapi/0_device-telemetry","items":[{"label":"Get list of device locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-telemetry/getdevicelocations","routeSlug":"/openapi/0_device-telemetry/getdevicelocations","metadata":{"seo":{"title":"Get list of device locations","description":"Returns list of device locations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceLocations","name":"Get list of device locations","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1location~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of device locations","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of device locations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1location~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_302","description":"Number of results to return per page."},{"name":"offset","in":"query","schemaId":"schema_302","description":"The initial index from which to return the results."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1location~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/report/location/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/report/location/","href":"0_device-telemetry/getdevicelocations","openApiOperationId":"getDeviceLocations","summary":"Get list of device locations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}},"schemaId":"schema_369"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1location~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_369","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_369"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-telemetry/getdevicelocations"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/location/"},{"label":"Get location of specific device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-telemetry/getspecificlocations","routeSlug":"/openapi/0_device-telemetry/getspecificlocations","metadata":{"seo":{"title":"Get location of specific device","description":"Returns location information of device"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpecificLocations","name":"Get location of specific device","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1location~1{location_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get location of specific device","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns location information of device"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"location_id","in":"path","schemaId":"schema_302","description":"An integer identifying the location.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1location~1{location_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/report/location/{location_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"location_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/report/location/{location_id}/","href":"0_device-telemetry/getspecificlocations","openApiOperationId":"getSpecificLocations","summary":"Get location of specific device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceLocations"}},"schemaId":"components/schemas/DeviceLocations"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1location~1{location_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceLocations","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceLocations"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-telemetry/getspecificlocations"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/location/{location_id}/"},{"label":"Get list of device tiles reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-telemetry/getdevicetilereports","routeSlug":"/openapi/0_device-telemetry/getdevicetilereports","metadata":{"seo":{"title":"Get list of device tiles reports","description":"Returns list of device tiles reports"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceTileReports","name":"Get list of device tiles reports","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1device-tiles~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of device tiles reports","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of device tiles reports"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1device-tiles~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state","in":"query","schemaId":"schema_302","description":"Filter device-tile reports by state."},{"name":"created_on_gt","in":"query","schemaId":"schema_304","description":"Filter device-tile reports created after a given timestamp."},{"name":"created_on_lt","in":"query","schemaId":"schema_304","description":"Flter device-tile reports created before a given timestamp."},{"name":"provisioned_on_gt","in":"query","schemaId":"schema_304","description":"Filter device-tile reports provisioned after a given timestamp."},{"name":"provisioned_on_lt","in":"query","schemaId":"schema_304","description":"Filter device-tile reports provisioned before a given timestamp."},{"name":"updated_on_gt","in":"query","schemaId":"schema_304","description":"Filter device-tile reports updated after a given timestamp."},{"name":"updated_on_lt","in":"query","schemaId":"schema_304","description":"Filter device-tile reports updated before a given timestamp."},{"name":"last_seen_gt","in":"query","schemaId":"schema_304","description":"Filter device-tile reports last seen after a given timestamp."},{"name":"last_seen_lt","in":"query","schemaId":"schema_304","description":"Filter device-tile reports last seen before a given timestamp."},{"name":"battery_level_gte","in":"query","schemaId":"schema_370","description":"Filter device-tile reports by battery level greater than given battery level."},{"name":"battery_level_lte","in":"query","schemaId":"schema_370","description":"Filter device-tile reports by battery level lower than given battery level."},{"name":"at_risk","in":"query","schemaId":"schema_301","description":"Filter device-tile reports by whether they are at risk."},{"name":"security_status","in":"query","schemaId":"schema_371"},{"name":"status","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by status."},{"name":"group","in":"query","schemaId":"schema_299","description":"Filter device-tile reports by group."},{"name":"group_name","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by group name."},{"name":"group_name_multi","in":"query","schemaId":"schema_372","description":"Filter device-tile reports using multiple group names."},{"name":"group_multi","in":"query","schemaId":"schema_373","description":"Filter device-tile reports by using multiple group ID's"},{"name":"group_multi_immediate","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by immediate groups"},{"name":"group_null","in":"query","schemaId":"schema_374","description":"Filter device-tile reports by availability of group. True returns device-tiles with no group. False returns device-tiles with group."},{"name":"imei","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by imei."},{"name":"name","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by device name."},{"name":"recently_added","in":"query","schemaId":"schema_301","description":"Filter device-tile reports by recently added."},{"name":"is_gms","in":"query","schemaId":"schema_301","description":"Filter device-tile reports for gms devices."},{"name":"tags","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by tag."},{"name":"is_geofence_applied","in":"query","schemaId":"schema_301","description":"Filter device-tile reports by geofence application."},{"name":"serial","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by device serial id."},{"name":"android_version","in":"query","schemaId":"schema_302","description":"Filter device-tile reports by android version."},{"name":"android_version_multi","in":"query","schemaId":"schema_375","description":"Filter device-tile reports by multiple android versions."},{"name":"wifi_ssid","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by wifi-ssid."},{"name":"network_type","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by network type."},{"name":"network_type_multi","in":"query","schemaId":"schema_376","description":"Filter device-tile reports by multiple network types."},{"name":"model","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by device model."},{"name":"template","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by template."},{"name":"template_multi","in":"query","schemaId":"schema_377","description":"Filter device-tile reports by multiple templates."},{"name":"policy","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by policy name."},{"name":"policy_multi","in":"query","schemaId":"schema_378","description":"Filter device-tile reports by multiple policies."},{"name":"policy_null","in":"query","schemaId":"schema_301","description":"Filter device-tile reports by null-value policy."},{"name":"dpc_version","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by DPC version."},{"name":"location","in":"query","schemaId":"schema_379","description":"Filter device-tile reports by location."},{"name":"active_connection","in":"query","schemaId":"schema_301","description":"Filter device-tile reports by active connection status."},{"name":"device_type","in":"query","schemaId":"schema_300","description":"Filter device-tile reports by device type."},{"name":"has_seamlessInfo","in":"query","schemaId":"schema_301","description":"Filter device-tile reports by seamless information."}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1device-tiles~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/report/device-tiles/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"state","in":"query","schemaId":"schema_302"},{"name":"created_on_gt","in":"query","schemaId":"schema_304"},{"name":"created_on_lt","in":"query","schemaId":"schema_304"},{"name":"provisioned_on_gt","in":"query","schemaId":"schema_304"},{"name":"provisioned_on_lt","in":"query","schemaId":"schema_304"},{"name":"updated_on_gt","in":"query","schemaId":"schema_304"},{"name":"updated_on_lt","in":"query","schemaId":"schema_304"},{"name":"last_seen_gt","in":"query","schemaId":"schema_304"},{"name":"last_seen_lt","in":"query","schemaId":"schema_304"},{"name":"battery_level_gte","in":"query","schemaId":"schema_370"},{"name":"battery_level_lte","in":"query","schemaId":"schema_370"},{"name":"at_risk","in":"query","schemaId":"schema_301"},{"name":"security_status","in":"query","schemaId":"components/schemas/SecurityStatesEnum"},{"name":"status","in":"query","schemaId":"schema_300"},{"name":"group","in":"query","schemaId":"schema_299"},{"name":"group_name","in":"query","schemaId":"schema_300"},{"name":"group_name_multi","in":"query","schemaId":"schema_372"},{"name":"group_multi","in":"query","schemaId":"schema_373"},{"name":"group_multi_immediate","in":"query","schemaId":"schema_300"},{"name":"group_null","in":"query","schemaId":"schema_374"},{"name":"imei","in":"query","schemaId":"schema_300"},{"name":"name","in":"query","schemaId":"schema_300"},{"name":"recently_added","in":"query","schemaId":"schema_301"},{"name":"is_gms","in":"query","schemaId":"schema_301"},{"name":"tags","in":"query","schemaId":"schema_300"},{"name":"is_geofence_applied","in":"query","schemaId":"schema_301"},{"name":"serial","in":"query","schemaId":"schema_300"},{"name":"android_version","in":"query","schemaId":"schema_302"},{"name":"android_version_multi","in":"query","schemaId":"schema_375"},{"name":"wifi_ssid","in":"query","schemaId":"schema_300"},{"name":"network_type","in":"query","schemaId":"schema_300"},{"name":"network_type_multi","in":"query","schemaId":"schema_376"},{"name":"model","in":"query","schemaId":"schema_300"},{"name":"template","in":"query","schemaId":"schema_300"},{"name":"template_multi","in":"query","schemaId":"schema_377"},{"name":"policy","in":"query","schemaId":"schema_300"},{"name":"policy_multi","in":"query","schemaId":"schema_378"},{"name":"policy_null","in":"query","schemaId":"schema_301"},{"name":"dpc_version","in":"query","schemaId":"schema_300"},{"name":"location","in":"query","schemaId":"schema_379"},{"name":"active_connection","in":"query","schemaId":"schema_301"},{"name":"device_type","in":"query","schemaId":"schema_300"},{"name":"has_seamlessInfo","in":"query","schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/report/device-tiles/","href":"0_device-telemetry/getdevicetilereports","openApiOperationId":"getDeviceTileReports","summary":"Get list of device tiles reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1device-tiles~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-telemetry/getdevicetilereports"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/device-tiles/"},{"label":"Get instance of device tiles report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-telemetry/getdevicetilereport","routeSlug":"/openapi/0_device-telemetry/getdevicetilereport","metadata":{"seo":{"title":"Get instance of device tiles report","description":"Returns instance of device tiles report"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceTileReport","name":"Get instance of device tiles report","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1device-tiles~1{device_tiles_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instance of device tiles report","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of device tiles report"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true},{"name":"device_tiles_id","in":"path","schemaId":"schema_302","description":"An integer representing the device tile report.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1device-tiles~1{device_tiles_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/report/device-tiles/{device_tiles_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"device_tiles_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/report/device-tiles/{device_tiles_id}/","href":"0_device-telemetry/getdevicetilereport","openApiOperationId":"getDeviceTileReport","summary":"Get instance of device tiles report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceTiles"}},"schemaId":"components/schemas/DeviceTiles"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1device-tiles~1{device_tiles_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceTiles","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceTiles"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-telemetry/getdevicetilereport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/device-tiles/{device_tiles_id}/"},{"label":"Get status metrics report for enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-telemetry/getstatusmetrics","routeSlug":"/openapi/0_device-telemetry/getstatusmetrics","metadata":{"seo":{"title":"Get status metrics report for enterprise","description":"Returns status metrics report for enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatusMetrics","name":"Get status metrics report for enterprise","isWebhook":false,"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1status-metrics~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get status metrics report for enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns status metrics report for enterprise"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1status-metrics~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/enterprise/{enterprise_id}/report/status-metrics/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/enterprise/{enterprise_id}/report/status-metrics/","href":"0_device-telemetry/getstatusmetrics","openApiOperationId":"getStatusMetrics","summary":"Get status metrics report for enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusMetrics"}},"schemaId":"components/schemas/StatusMetrics"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v1~1enterprise~1{enterprise_id}~1report~1status-metrics~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusMetrics","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusMetrics"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-telemetry/getstatusmetrics"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v1/enterprise/{enterprise_id}/report/status-metrics/"},{"label":"Get status metrics report for enterprise v2","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_device-telemetry/getstatusmetricsv2","routeSlug":"/openapi/0_device-telemetry/getstatusmetricsv2","metadata":{"seo":{"title":"Get status metrics report for enterprise v2","description":"Returns status metrics report for enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatusMetricsV2","name":"Get status metrics report for enterprise v2","isWebhook":false,"pointer":"/paths/~1v2~1enterprise~1{enterprise_id}~1report~1status-metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get status metrics report for enterprise v2","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns status metrics report for enterprise"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_300","description":"A UUID string identifying this enterprise.","required":true}],"pointer":"/paths/~1v2~1enterprise~1{enterprise_id}~1report~1status-metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/enterprise/{enterprise_id}/report/status-metrics","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v2/enterprise/{enterprise_id}/report/status-metrics","href":"0_device-telemetry/getstatusmetricsv2","openApiOperationId":"getStatusMetricsV2","summary":"Get status metrics report for enterprise v2"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusMetricsV2"}},"schemaId":"components/schemas/StatusMetricsV2"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v2~1enterprise~1{enterprise_id}~1report~1status-metrics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusMetricsV2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatusMetricsV2"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_device-telemetry/getstatusmetricsv2"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/enterprise/{enterprise_id}/report/status-metrics"}],"content":{"contentType":"group","meta":{"name":"0_Device Telemetry"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Telemetry","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/enterprise/{enterprise_id}/report/location/","summary":"Get list of device locations","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-telemetry/getdevicelocations","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/report/location/{location_id}/","summary":"Get location of specific device","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-telemetry/getspecificlocations","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/report/device-tiles/","summary":"Get list of device tiles reports","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-telemetry/getdevicetilereports","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/report/device-tiles/{device_tiles_id}/","summary":"Get instance of device tiles report","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-telemetry/getdevicetilereport","deprecated":false},{"title":"/v1/enterprise/{enterprise_id}/report/status-metrics/","summary":"Get status metrics report for enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-telemetry/getstatusmetrics","deprecated":false},{"title":"/v2/enterprise/{enterprise_id}/report/status-metrics","summary":"Get status metrics report for enterprise v2","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_device-telemetry/getstatusmetricsv2","deprecated":false}]}]}]}]}},{"type":"group","label":"Daily and Custom Reports","link":"/openapi/0_daily-and-custom-reports","routeSlug":"/openapi/0_daily-and-custom-reports","items":[{"label":"Get report information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/getreportinfo","routeSlug":"/openapi/0_daily-and-custom-reports/getreportinfo","metadata":{"seo":{"title":"Get report information","description":"Returns report information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportInfo","name":"Get report information","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1info~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get report information","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns report information"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/report/info/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/report/info/","href":"0_daily-and-custom-reports/getreportinfo","openApiOperationId":"getReportInfo","summary":"Get report information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1info~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/getreportinfo"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/info/"},{"label":"Get device status reports within specified date-time range","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/getdevicereport","routeSlug":"/openapi/0_daily-and-custom-reports/getdevicereport","metadata":{"seo":{"title":"Get device status reports within specified date-time range","description":"Returns device status reports within specified date-time range"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceReport","name":"Get device status reports within specified date-time range","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1device-report~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get device status reports within specified date-time range","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns device status reports within specified date-time range"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_316","description":"Start date of range in which to retrieve device status reports","required":true},{"name":"end_date","in":"query","schemaId":"schema_316","description":"End date of range in which to retrieve device status reports","required":true},{"name":"sync","in":"query","schemaId":"schema_382","description":"Sync device status report to specified field"},{"name":"fields","in":"query","schemaId":"schema_300","description":"List of fields to add to device status report, comma separated"}],"pointer":"/paths/~1enterprise~1report~1device-report~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/report/device-report/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"start_date","in":"query","required":true,"schemaId":"schema_316"},{"name":"end_date","in":"query","required":true,"schemaId":"schema_316"},{"name":"sync","in":"query","required":false,"schemaId":"schema_382"},{"name":"fields","in":"query","required":false,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/report/device-report/","href":"0_daily-and-custom-reports/getdevicereport","openApiOperationId":"getDeviceReport","summary":"Get device status reports within specified date-time range"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1device-report~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/getdevicereport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/device-report/"},{"label":"Get enterprise report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/getenterprisereport","routeSlug":"/openapi/0_daily-and-custom-reports/getenterprisereport","metadata":{"seo":{"title":"Get enterprise report","description":"Returns enterprise report of devices within specified date-time range"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnterpriseReport","name":"Get enterprise report","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1enterprise-report~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get enterprise report","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns enterprise report of devices within specified date-time range"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_316","description":"Start date of range in which to retrieve enterprise report.","required":true},{"name":"end_date","in":"query","schemaId":"schema_316","description":"End date of range in which to retrieve enterprise report.","required":true}],"pointer":"/paths/~1enterprise~1report~1enterprise-report~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/report/enterprise-report/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"start_date","in":"query","required":true,"schemaId":"schema_316"},{"name":"end_date","in":"query","required":true,"schemaId":"schema_316"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/report/enterprise-report/","href":"0_daily-and-custom-reports/getenterprisereport","openApiOperationId":"getEnterpriseReport","summary":"Get enterprise report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1enterprise-report~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/getenterprisereport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/enterprise-report/"},{"label":"Get group report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/getgroupreport","routeSlug":"/openapi/0_daily-and-custom-reports/getgroupreport","metadata":{"seo":{"title":"Get group report","description":"Returns group report of devices within specified date-time range"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupReport","name":"Get group report","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1group-report~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get group report","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns group report of devices within specified date-time range"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_date","in":"query","schemaId":"schema_316","description":"Start date of range in which to retrieve group report.","required":true},{"name":"end_date","in":"query","schemaId":"schema_316","description":"End date of range in which to retrieve group report.","required":true},{"name":"sync","in":"query","schemaId":"schema_382","description":"Sync device status report to specified field"}],"pointer":"/paths/~1enterprise~1report~1group-report~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/report/group-report/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"start_date","in":"query","required":true,"schemaId":"schema_316"},{"name":"end_date","in":"query","required":true,"schemaId":"schema_316"},{"name":"sync","in":"query","required":false,"schemaId":"schema_382"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/report/group-report/","href":"0_daily-and-custom-reports/getgroupreport","openApiOperationId":"getGroupReport","summary":"Get group report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1group-report~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_385"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/getgroupreport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/group-report/"},{"label":"Get list of subscription reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/getsubscriptionreports","routeSlug":"/openapi/0_daily-and-custom-reports/getsubscriptionreports","metadata":{"seo":{"title":"Get list of subscription reports","description":"Returns list of subscription reports"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionReports","name":"Get list of subscription reports","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1subscription~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of subscription reports","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns list of subscription reports"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/report/subscription/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/report/subscription/","href":"0_daily-and-custom-reports/getsubscriptionreports","openApiOperationId":"getSubscriptionReports","summary":"Get list of subscription reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1subscription~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_386"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/getsubscriptionreports"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/"},{"label":"Post subscription to enterprise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/addsubscription","routeSlug":"/openapi/0_daily-and-custom-reports/addsubscription","metadata":{"seo":{"title":"Post subscription to enterprise","description":"Returns instance of created subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addSubscription","name":"Post subscription to enterprise","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1subscription~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Post subscription to enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of created subscription"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387","pointer":"/paths/~1enterprise~1report~1subscription~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/enterprise/report/subscription/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_387"}},"responseCodes":["201","400","401","403","500"],"pointer":"/enterprise/report/subscription/","href":"0_daily-and-custom-reports/addsubscription","openApiOperationId":"addSubscription","summary":"Post subscription to enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_387"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1subscription~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/addsubscription"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/"},{"label":"Get instance of subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/getsubscriptionreport","routeSlug":"/openapi/0_daily-and-custom-reports/getsubscriptionreport","metadata":{"seo":{"title":"Get instance of subscription","description":"Returns instance of subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionReport","name":"Get instance of subscription","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get instance of subscription","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of subscription"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_302","description":"A integer value identifying the subscription","required":true}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/enterprise/report/subscription/{subscription_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/enterprise/report/subscription/{subscription_id}/","href":"0_daily-and-custom-reports/getsubscriptionreport","openApiOperationId":"getSubscriptionReport","summary":"Get instance of subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/getsubscriptionreport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"},{"label":"Update subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/updatesubscriptionreport","routeSlug":"/openapi/0_daily-and-custom-reports/updatesubscriptionreport","metadata":{"seo":{"title":"Update subscription","description":"Returns instance of updated subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscriptionReport","name":"Update subscription","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update subscription","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of updated subscription"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_302","description":"A integer value identifying the subscription.","required":true}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388","pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/enterprise/report/subscription/{subscription_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_388"}},"responseCodes":["200","400","401","404","500"],"pointer":"/enterprise/report/subscription/{subscription_id}/","href":"0_daily-and-custom-reports/updatesubscriptionreport","openApiOperationId":"updateSubscriptionReport","summary":"Update subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/updatesubscriptionreport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"},{"label":"Partially update subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/patchsubscriptionreport","routeSlug":"/openapi/0_daily-and-custom-reports/patchsubscriptionreport","metadata":{"seo":{"title":"Partially update subscription","description":"Returns instance of updated subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSubscriptionReport","name":"Partially update subscription","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update subscription","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns instance of updated subscription"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_302","description":"A integer value identifying the subscription.","required":true}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"schemaId":"schema_389","pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/enterprise/report/subscription/{subscription_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_389"}},"responseCodes":["200","400","401","404","500"],"pointer":"/enterprise/report/subscription/{subscription_id}/","href":"0_daily-and-custom-reports/patchsubscriptionreport","openApiOperationId":"patchSubscriptionReport","summary":"Partially update subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_389","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_389"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}},"schemaId":"components/schemas/Subscription"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Subscription","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Subscription"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/patchsubscriptionreport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"},{"label":"Deletes instance of subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_daily-and-custom-reports/deletesubscriptionreport","routeSlug":"/openapi/0_daily-and-custom-reports/deletesubscriptionreport","metadata":{"seo":{"title":"Deletes instance of subscription","description":"Empty response"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSubscriptionReport","name":"Deletes instance of subscription","isWebhook":false,"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes instance of subscription","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Empty response"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_302","description":"A integer value identifying the subscription.","required":true}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/enterprise/report/subscription/{subscription_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500"],"pointer":"/enterprise/report/subscription/{subscription_id}/","href":"0_daily-and-custom-reports/deletesubscriptionreport","openApiOperationId":"deleteSubscriptionReport","summary":"Deletes instance of subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"The resource was deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1enterprise~1report~1subscription~1{subscription_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_daily-and-custom-reports/deletesubscriptionreport"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/enterprise/report/subscription/{subscription_id}/"}],"content":{"contentType":"group","meta":{"name":"0_Daily and Custom Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Daily and Custom Reports","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/enterprise/report/info/","summary":"Get report information","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/getreportinfo","deprecated":false},{"title":"/enterprise/report/device-report/","summary":"Get device status reports within specified date-time range","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/getdevicereport","deprecated":false},{"title":"/enterprise/report/enterprise-report/","summary":"Get enterprise report","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/getenterprisereport","deprecated":false},{"title":"/enterprise/report/group-report/","summary":"Get group report","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/getgroupreport","deprecated":false},{"title":"/enterprise/report/subscription/","summary":"Get list of subscription reports","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/getsubscriptionreports","deprecated":false},{"title":"/enterprise/report/subscription/","summary":"Post subscription to enterprise","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/addsubscription","deprecated":false},{"title":"/enterprise/report/subscription/{subscription_id}/","summary":"Get instance of subscription","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/getsubscriptionreport","deprecated":false},{"title":"/enterprise/report/subscription/{subscription_id}/","summary":"Update subscription","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/updatesubscriptionreport","deprecated":false},{"title":"/enterprise/report/subscription/{subscription_id}/","summary":"Partially update subscription","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/patchsubscriptionreport","deprecated":false},{"title":"/enterprise/report/subscription/{subscription_id}/","summary":"Deletes instance of subscription","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_daily-and-custom-reports/deletesubscriptionreport","deprecated":false}]}]}]}]}},{"type":"group","label":"SSO Connections","link":"/openapi/0_sso-connections","routeSlug":"/openapi/0_sso-connections","items":[{"label":"List SSO connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_sso-connections/getconnections","routeSlug":"/openapi/0_sso-connections/getconnections","metadata":{"seo":{"title":"List SSO connections","description":"List SSO connections of a tenant. Learn more about SSO Connections."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConnections","name":"List SSO connections","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List SSO connections","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List SSO connections of a tenant. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"target":"_blank","href":"https://help.esper.io/hc/en-us/articles/14266541959569-Introduction-to-User-Authentication"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SSO Connections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"is_default","in":"query","schemaId":"schema_301","description":"Is Default"}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authn2/v0/tenant/{enterprise_id}/connection","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"is_default","in":"query","required":false,"schemaId":"schema_301"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/authn2/v0/tenant/{enterprise_id}/connection","href":"0_sso-connections/getconnections","openApiOperationId":"getConnections","summary":"List SSO connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tenant connections","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}},"schemaId":"schema_390"},{"code":"400","description":"List custom connections error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_390","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_390"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_sso-connections/getconnections"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/connection"},{"label":"Edit SSO connections","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_sso-connections/editcustomconnection","routeSlug":"/openapi/0_sso-connections/editcustomconnection","metadata":{"seo":{"title":"Edit SSO connections","description":"Edit SSO connections"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editCustomConnection","name":"Edit SSO connections","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection~1{connection_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit SSO connections","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Edit SSO connections"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"enterprise_id","in":"path","schemaId":"schema_299","description":"Enterprise ID","required":true},{"name":"connection_id","in":"path","schemaId":"schema_299","description":"Connection ID","required":true}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection~1{connection_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomConnectionRequest"}},"schemaId":"components/schemas/CustomConnectionRequest","pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection~1{connection_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authn2/v0/tenant/{enterprise_id}/connection/{connection_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"enterprise_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"connection_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomConnectionRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/authn2/v0/tenant/{enterprise_id}/connection/{connection_id}","href":"0_sso-connections/editcustomconnection","openApiOperationId":"editCustomConnection","summary":"Edit SSO connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/CustomConnectionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomConnectionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated connection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomConnectionResponse"}},"schemaId":"components/schemas/CustomConnectionResponse"},{"code":"400","description":"custom connection update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"403","description":"Forbidden, no permission to perform this action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1tenant~1{enterprise_id}~1connection~1{connection_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomConnectionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomConnectionResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"403","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_sso-connections/editcustomconnection"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/tenant/{enterprise_id}/connection/{connection_id}"}],"content":{"contentType":"group","meta":{"name":"0_SSO Connections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SSO Connections","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authn2/v0/tenant/{enterprise_id}/connection","summary":"List SSO connections","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_sso-connections/getconnections","deprecated":false},{"title":"/authn2/v0/tenant/{enterprise_id}/connection/{connection_id}","summary":"Edit SSO connections","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_sso-connections/editcustomconnection","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/openapi/0_roles","routeSlug":"/openapi/0_roles","items":[{"label":"List Roles API","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_roles/getroleurl","routeSlug":"/openapi/0_roles/getroleurl","metadata":{"seo":{"title":"List Roles API","description":"API to retrieve all the roles for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRoleURL","name":"List Roles API","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1roles~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Roles API","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to retrieve all the roles for the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authz2/v1/roles/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/authz2/v1/roles/","href":"0_roles/getroleurl","openApiOperationId":"GetRoleURL","summary":"List Roles API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Succeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391"}},"schemaId":"schema_391"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1roles~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_391","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_391"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_roles/getroleurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/"},{"label":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_roles/postroleurl","routeSlug":"/openapi/0_roles/postroleurl","metadata":{"seo":{"title":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default.","description":"Learn more about Creating Custom Roles."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PostRoleURL","name":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default.","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1roles~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default.","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more about "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"target":"_blank","href":"https://help.esper.io/hc/en-us/articles/13714316325393-Creating-Custom-Roles"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating Custom Roles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Role"}},"schemaId":"components/schemas/Role","pointer":"/paths/~1authz2~1v1~1roles~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authz2/v1/roles/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Role"}},"responseCodes":["200","400","401"],"pointer":"/authz2/v1/roles/","href":"0_roles/postroleurl","openApiOperationId":"PostRoleURL","summary":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Role","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Role"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Succeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleResponse"}},"schemaId":"components/schemas/RoleResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1roles~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_roles/postroleurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/"},{"label":"Get Role API","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_roles/getroleidurl","routeSlug":"/openapi/0_roles/getroleidurl","metadata":{"seo":{"title":"Get Role API","description":"API to retrieve the role for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRoleIdURL","name":"Get Role API","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Role API","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to retrieve the role for the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_299","description":"Role ID","required":true}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authz2/v1/roles/{role_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/authz2/v1/roles/{role_id}","href":"0_roles/getroleidurl","openApiOperationId":"GetRoleIdURL","summary":"Get Role API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Succeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleResponse"}},"schemaId":"components/schemas/RoleResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_roles/getroleidurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}"},{"label":"Patch Role API","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_roles/updateroleidurl","routeSlug":"/openapi/0_roles/updateroleidurl","metadata":{"seo":{"title":"Patch Role API","description":"API to update role details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateRoleIdURL","name":"Patch Role API","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch Role API","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to update role details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_299","description":"Role ID","required":true}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Role"}},"schemaId":"components/schemas/Role","pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/authz2/v1/roles/{role_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Role"}},"responseCodes":["200","400","401"],"pointer":"/authz2/v1/roles/{role_id}","href":"0_roles/updateroleidurl","openApiOperationId":"UpdateRoleIdURL","summary":"Patch Role API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Role","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Role"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Succeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleResponse"}},"schemaId":"components/schemas/RoleResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_roles/updateroleidurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}"},{"label":"Delete Role API","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_roles/deleteroleidurl","routeSlug":"/openapi/0_roles/deleteroleidurl","metadata":{"seo":{"title":"Delete Role API","description":"API to delete the role for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteRoleIdURL","name":"Delete Role API","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Role API","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to delete the role for the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_299","description":"Role ID","required":true}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/authz2/v1/roles/{role_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401"],"pointer":"/authz2/v1/roles/{role_id}","href":"0_roles/deleteroleidurl","openApiOperationId":"DeleteRoleIdURL","summary":"Delete Role API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted succesfully"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_roles/deleteroleidurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}"},{"label":"Update Role Scopes API","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_roles/putrolescopeurl","routeSlug":"/openapi/0_roles/putrolescopeurl","metadata":{"seo":{"title":"Update Role Scopes API","description":"API to update scopes of an roles for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutRoleScopeURL","name":"Update Role Scopes API","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}~1scopes/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Role Scopes API","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to update scopes of an roles for the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_299","description":"Role ID","required":true}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}~1scopes/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_392"}},"schemaId":"schema_392","pointer":"/paths/~1authz2~1v1~1roles~1{role_id}~1scopes/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authz2/v1/roles/{role_id}/scopes","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_392"}},"responseCodes":["200","400","401"],"pointer":"/authz2/v1/roles/{role_id}/scopes","href":"0_roles/putrolescopeurl","openApiOperationId":"PutRoleScopeURL","summary":"Update Role Scopes API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_392","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_392"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Succeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}~1scopes/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_roles/putrolescopeurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}/scopes"},{"label":"List Role Scopes API","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_roles/getrolescopeurl","routeSlug":"/openapi/0_roles/getrolescopeurl","metadata":{"seo":{"title":"List Role Scopes API","description":"API to retrieve scopes of an roles for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetRoleScopeURL","name":"List Role Scopes API","isWebhook":false,"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}~1scopes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Role Scopes API","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to retrieve scopes of an roles for the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"role_id","in":"path","schemaId":"schema_299","description":"Role ID","required":true}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}~1scopes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authz2/v1/roles/{role_id}/scopes","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"role_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/authz2/v1/roles/{role_id}/scopes","href":"0_roles/getrolescopeurl","openApiOperationId":"GetRoleScopeURL","summary":"List Role Scopes API"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request Succeded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393"}},"schemaId":"schema_393"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authz2~1v1~1roles~1{role_id}~1scopes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_393","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_393"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_roles/getrolescopeurl"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authz2/v1/roles/{role_id}/scopes"}],"content":{"contentType":"group","meta":{"name":"0_Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authz2/v1/roles/","summary":"List Roles API","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_roles/getroleurl","deprecated":false},{"title":"/authz2/v1/roles/","summary":"Create a new role. Then optionally add scopes by using the Update Role Scopes API. No scopes are added by default.","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_roles/postroleurl","deprecated":false},{"title":"/authz2/v1/roles/{role_id}","summary":"Get Role API","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_roles/getroleidurl","deprecated":false},{"title":"/authz2/v1/roles/{role_id}","summary":"Patch Role API","prefix":{"name":"patch","color":"patch"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_roles/updateroleidurl","deprecated":false},{"title":"/authz2/v1/roles/{role_id}","summary":"Delete Role API","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_roles/deleteroleidurl","deprecated":false},{"title":"/authz2/v1/roles/{role_id}/scopes","summary":"Update Role Scopes API","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_roles/putrolescopeurl","deprecated":false},{"title":"/authz2/v1/roles/{role_id}/scopes","summary":"List Role Scopes API","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_roles/getrolescopeurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Personal Access Token","link":"/openapi/0_personal-access-token","routeSlug":"/openapi/0_personal-access-token","items":[{"label":"Generate a new personal access token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/post","routeSlug":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/post","metadata":{"seo":{"title":"Generate a new personal access token","description":"This endpoint allows clients to generate a new personal access token for a specific user and tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Generate a new personal access token","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1personal-access-token~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a new personal access token","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows clients to generate a new personal access token for a specific user and tenant.\n"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_394"}},"schemaId":"schema_394","pointer":"/paths/~1authn2~1v0~1personal-access-token~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authn2/v0/personal-access-token/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_394"}},"responseCodes":["200","400","401"],"pointer":"/authn2/v0/personal-access-token/","href":"0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/post","summary":"Generate a new personal access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_394","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_394"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Token successfully generated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalAccessTokenCreateResponse"}},"schemaId":"components/schemas/PersonalAccessTokenCreateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1personal-access-token~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonalAccessTokenCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalAccessTokenCreateResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/post"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/"},{"label":"Get tokens for corresponding user and tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/get","routeSlug":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/get","metadata":{"seo":{"title":"Get tokens for corresponding user and tenant","description":"Get all tokens associated with the given user and tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get tokens for corresponding user and tenant","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1personal-access-token~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tokens for corresponding user and tenant","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all tokens associated with the given user and tenant."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authn2/v0/personal-access-token/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401"],"pointer":"/authn2/v0/personal-access-token/","href":"0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/get","summary":"Get tokens for corresponding user and tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalAccessTokenGetResponse"}},"schemaId":"components/schemas/PersonalAccessTokenGetResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1personal-access-token~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonalAccessTokenGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalAccessTokenGetResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/"},{"label":"Renew personal access token","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put","routeSlug":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put","metadata":{"seo":{"title":"Renew personal access token","description":"Renew token associated with the given token_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Renew personal access token","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Renew personal access token","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Renew token associated with the given token_id."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personal_access_token_id","in":"path","schemaId":"schema_299","description":"Personal Access Token Id","required":true}],"pointer":"/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"schemaId":"schema_395","pointer":"/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authn2/v0/personal-access-token/{personal_access_token_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"personal_access_token_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_395"}},"responseCodes":["200","400","401"],"pointer":"/authn2/v0/personal-access-token/{personal_access_token_id}","href":"0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put","summary":"Renew personal access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_395","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_395"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalAccessTokenUpdateResponse"}},"schemaId":"components/schemas/PersonalAccessTokenUpdateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonalAccessTokenUpdateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonalAccessTokenUpdateResponse"}}},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/{personal_access_token_id}"},{"label":"Delete personal access token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete","routeSlug":"/openapi/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete","metadata":{"seo":{"title":"Delete personal access token","description":"Delete token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete personal access token","isWebhook":false,"pointer":"/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete personal access token","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete token."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"personal_access_token_id","in":"path","schemaId":"schema_299","description":"Personal Access Token Id","required":true}],"pointer":"/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/authn2/v0/personal-access-token/{personal_access_token_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"personal_access_token_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401"],"pointer":"/authn2/v0/personal-access-token/{personal_access_token_id}","href":"0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete","summary":"Delete personal access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}},"schemaId":"components/schemas/GenericErrorResponse"}],"pointer":"/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}},{"code":"401","schemaId":"components/schemas/GenericErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GenericErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/authn2/v0/personal-access-token/{personal_access_token_id}"}],"content":{"contentType":"group","meta":{"name":"0_Personal Access Token"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Personal Access Token","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authn2/v0/personal-access-token/","summary":"Generate a new personal access token","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/post","deprecated":false},{"title":"/authn2/v0/personal-access-token/","summary":"Get tokens for corresponding user and tenant","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1/get","deprecated":false},{"title":"/authn2/v0/personal-access-token/{personal_access_token_id}","summary":"Renew personal access token","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/put","deprecated":false},{"title":"/authn2/v0/personal-access-token/{personal_access_token_id}","summary":"Delete personal access token","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/0_personal-access-token/paths/~1authn2~1v0~1personal-access-token~1{personal_access_token_id}/delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"BLUEPRINTS","content":null},{"type":"group","label":"Blueprints API","link":"/openapi/1_blueprints-api","routeSlug":"/openapi/1_blueprints-api","items":[{"label":"/v2/blueprints/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1/get","routeSlug":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1/get","metadata":{"seo":{"title":"/v2/blueprints/","description":"Retrieve all blueprints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/blueprints/","isWebhook":false,"pointer":"/paths/~1v2~1blueprints~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/blueprints/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all blueprints"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ordering","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order the results by a specific field (-field for descending order), Combine Multiple with , like -created_at,-updated_at."},"children":[]}]}]}]},{"name":"name","in":"query","schemaId":"schema_300","description":"Filter the results by name, case insensitive\n"},{"name":"name_exact","in":"query","schemaId":"schema_300","description":"Filter the results by name, case sensitive and matches exact name\n"},{"name":"settings__android__app_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given app_id in any of the versions for android apps."},"children":[]}]}]}]},{"name":"settings__android__app_version_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given app_version_id in any of the versions for android apps."},"children":[]}]}]}]},{"name":"settings__ios__app_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given app_id in any of the versions for ios apps."},"children":[]}]}]}]},{"name":"settings__ios__app_version_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given app_version_id in any of the versions for ios apps."},"children":[]}]}]}]},{"name":"settings__windows__app_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given app_id in any of the versions for windows apps."},"children":[]}]}]}]},{"name":"settings__windows__app_version_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given app_version_id in any of the versions for windows apps."},"children":[]}]}]}]},{"name":"settings__android__file_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given file_id in any of the versions."},"children":[]}]}]}]},{"name":"settings__android__wifi_network_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given wifi_network_id in any of the versions."},"children":[]}]}]}]},{"name":"settings__ios__provisioning_profile_id","in":"query","schemaId":"schema_299","description":"Filter blueprints that have the given provisioning profile ID in any version.\n"},{"name":"settings__ios__provisioning_profile_version_id","in":"query","schemaId":"schema_299","description":"Filter blueprints that have the given provisioning profile version ID in any version.\n"}],"pointer":"/paths/~1v2~1blueprints~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/blueprints/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"ordering","in":"query","schemaId":"schema_300"},{"name":"name","in":"query","schemaId":"schema_300"},{"name":"name_exact","in":"query","schemaId":"schema_300"},{"name":"settings__android__app_id","in":"query","schemaId":"schema_299"},{"name":"settings__android__app_version_id","in":"query","schemaId":"schema_299"},{"name":"settings__ios__app_id","in":"query","schemaId":"schema_299"},{"name":"settings__ios__app_version_id","in":"query","schemaId":"schema_299"},{"name":"settings__windows__app_id","in":"query","schemaId":"schema_299"},{"name":"settings__windows__app_version_id","in":"query","schemaId":"schema_299"},{"name":"settings__android__file_id","in":"query","schemaId":"schema_299"},{"name":"settings__android__wifi_network_id","in":"query","schemaId":"schema_299"},{"name":"settings__ios__provisioning_profile_id","in":"query","schemaId":"schema_299"},{"name":"settings__ios__provisioning_profile_version_id","in":"query","schemaId":"schema_299"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/v2/blueprints/","href":"1_blueprints-api/paths/~1v2~1blueprints~1/get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396"}],"pointer":"/paths/~1v2~1blueprints~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_blueprints-api/paths/~1v2~1blueprints~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/"},{"label":"/v2/blueprints/","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1/post","routeSlug":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1/post","metadata":{"seo":{"title":"/v2/blueprints/","description":"Create a new blueprint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/blueprints/","isWebhook":false,"pointer":"/paths/~1v2~1blueprints~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/blueprints/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new blueprint"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlueprintV2"}},"schemaId":"components/schemas/BlueprintV2","pointer":"/paths/~1v2~1blueprints~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/blueprints/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BlueprintV2"}},"responseCodes":["201","400"],"pointer":"/v2/blueprints/","href":"1_blueprints-api/paths/~1v2~1blueprints~1/post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/BlueprintV2","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlueprintV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}},"schemaId":"schema_398"}],"pointer":"/paths/~1v2~1blueprints~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}}},{"code":"400","schemaId":"schema_398","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_398"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_blueprints-api/paths/~1v2~1blueprints~1/post"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/"},{"label":"/v2/blueprints/{blueprint_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/get","routeSlug":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/get","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/","description":"Retrieve a blueprint by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/blueprints/{blueprint_id}/","isWebhook":false,"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/blueprints/{blueprint_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a blueprint by ID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blueprint_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/blueprints/{blueprint_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/v2/blueprints/{blueprint_id}/","href":"1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}},"schemaId":"schema_397"},{"code":"404","description":"Content not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}},"schemaId":"schema_399"}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_397","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_397"}}},{"code":"404","schemaId":"schema_399","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_399"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/"},{"label":"/v2/blueprints/{blueprint_id}/","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/put","routeSlug":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/put","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/","description":"Update a blueprint by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/blueprints/{blueprint_id}/","isWebhook":false,"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/blueprints/{blueprint_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a blueprint by ID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blueprint_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlueprintV2Put"}},"schemaId":"components/schemas/BlueprintV2Put","pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/blueprints/{blueprint_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BlueprintV2Put"}},"responseCodes":["200","400","404"],"pointer":"/v2/blueprints/{blueprint_id}/","href":"1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/put"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/BlueprintV2Put","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BlueprintV2Put"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}},"schemaId":"schema_401"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}},"schemaId":"schema_402"}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}}},{"code":"400","schemaId":"schema_401","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_401"}}},{"code":"404","schemaId":"schema_402","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_402"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/put"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/"},{"label":"/v2/blueprints/{blueprint_id}/","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/delete","routeSlug":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/delete","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/","description":"Delete a blueprint by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/blueprints/{blueprint_id}/","isWebhook":false,"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/blueprints/{blueprint_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a blueprint by ID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blueprint_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/blueprints/{blueprint_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","404"],"pointer":"/v2/blueprints/{blueprint_id}/","href":"1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}},"schemaId":"schema_403"}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}}},{"code":"404","schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/delete"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/"},{"label":"/v2/blueprints/{blueprint_id}/versions/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get","routeSlug":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/versions/","description":"Retrieve all versions of a blueprint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/blueprints/{blueprint_id}/versions/","isWebhook":false,"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/blueprints/{blueprint_id}/versions/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all versions of a blueprint"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blueprint_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ordering","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order the results by a specific field (-field for descending order), Combine Multiple with , like -version_number,-minor_version_number."},"children":[]}]}]}]},{"name":"version_number","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter the results by version_number"},"children":[]}]}]}]},{"name":"publish","in":"query","schemaId":"schema_300","description":"Filter the results by publish\n"},{"name":"settings__android__app_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the versions which have given app_id."},"children":[]}]}]}]},{"name":"settings__android__app_version_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the versions which have given app_version_id."},"children":[]}]}]}]},{"name":"settings__android__file_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given file_id."},"children":[]}]}]}]},{"name":"settings__android__wifi_network_id","in":"query","schemaId":"schema_299","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List the blueprints which have given wifi_network_id."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/blueprints/{blueprint_id}/versions/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"ordering","in":"query","schemaId":"schema_300"},{"name":"version_number","in":"query","schemaId":"schema_300"},{"name":"publish","in":"query","schemaId":"schema_300"},{"name":"settings__android__app_id","in":"query","schemaId":"schema_299"},{"name":"settings__android__app_version_id","in":"query","schemaId":"schema_299"},{"name":"settings__android__file_id","in":"query","schemaId":"schema_299"},{"name":"settings__android__wifi_network_id","in":"query","schemaId":"schema_299"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/v2/blueprints/{blueprint_id}/versions/","href":"1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}},"schemaId":"schema_396"}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_396","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_396"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/versions/"},{"label":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get","routeSlug":"/openapi/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get","metadata":{"seo":{"title":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","description":"Retrieve a specific version of the blueprint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","isWebhook":false,"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific version of the blueprint"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"blueprint_id","in":"path","schemaId":"schema_299","required":true},{"name":"version_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"blueprint_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"version_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","href":"1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}},"schemaId":"schema_400"},{"code":"404","description":"Resouce not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}},"schemaId":"schema_403"}],"pointer":"/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_400","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_400"}}},{"code":"404","schemaId":"schema_403","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_403"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/blueprints/{blueprint_id}/versions/{version_id}/"}],"content":{"contentType":"group","meta":{"name":"1_Blueprints API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blueprints API","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to manage blueprints. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/19118758564369-Introduction-to-Blueprints"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"blueprints"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/blueprints/","summary":"Retrieve all blueprints","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_blueprints-api/paths/~1v2~1blueprints~1/get","deprecated":false},{"title":"/v2/blueprints/","summary":"Create a new blueprint","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_blueprints-api/paths/~1v2~1blueprints~1/post","deprecated":false},{"title":"/v2/blueprints/{blueprint_id}/","summary":"Retrieve a blueprint by ID","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/get","deprecated":false},{"title":"/v2/blueprints/{blueprint_id}/","summary":"Update a blueprint by ID","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/put","deprecated":false},{"title":"/v2/blueprints/{blueprint_id}/","summary":"Delete a blueprint by ID","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1/delete","deprecated":false},{"title":"/v2/blueprints/{blueprint_id}/versions/","summary":"Retrieve all versions of a blueprint","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1/get","deprecated":false},{"title":"/v2/blueprints/{blueprint_id}/versions/{version_id}/","summary":"Retrieve a specific version of the blueprint","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_blueprints-api/paths/~1v2~1blueprints~1{blueprint_id}~1versions~1{version_id}~1/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Actions API","link":"/openapi/1_custom-actions-api","routeSlug":"/openapi/1_custom-actions-api","items":[{"label":"/v2/custom-actions/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1/get","routeSlug":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1/get","metadata":{"seo":{"title":"/v2/custom-actions/","description":"Retrieve all custom actions for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/custom-actions/","isWebhook":false,"pointer":"/paths/~1v2~1custom-actions~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/custom-actions/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all custom actions for the tenant"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ordering","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order the results by a specific field (-field for descending order). Valid fields are 'name', 'created_at', 'updated_at', 'created_by', 'updated_by'."},"children":[]}]}]}]},{"name":"name","in":"query","schemaId":"schema_300","description":"Filter the results by name (partial match, case insensitive).\n"},{"name":"type","in":"query","schemaId":"schema_300","description":"Filter by action type. Comma-separated list. Valid values: button, toggle, radio, dropdown.\n"},{"name":"state","in":"query","schemaId":"schema_300","description":"Filter by action state. Comma-separated list. Valid values: draft, active, inactive.\n"},{"name":"position_in_blueprints","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by blueprint position. Comma-separated list. Valid values: none, blueprints_apps_and_configuration, blueprints_connectivity, blueprints_device_security, blueprints_display_and_branding, blueprints_esper_settings, blueprints_scripts, blueprints_files, blueprints_platform_services, blueprints_hardware_settings, blueprints_sound, blueprints_system_updates, blueprints_time_and_date."},"children":[]}]}]}]},{"name":"position_in_device_settings","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by device settings position. Comma-separated list. Valid values: none, device_quick_settings."},"children":[]}]}]}]},{"name":"created_by","in":"query","schemaId":"schema_302","description":"Filter by user ID who created the action.\n"},{"name":"updated_by","in":"query","schemaId":"schema_302","description":"Filter by user ID who last updated the action.\n"},{"name":"limit","in":"query","schemaId":"schema_404","description":"Number of results to return per page.\n"},{"name":"offset","in":"query","schemaId":"schema_405","description":"The initial index from which to return the results.\n"}],"pointer":"/paths/~1v2~1custom-actions~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/custom-actions/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"ordering","in":"query","schemaId":"schema_300"},{"name":"name","in":"query","schemaId":"schema_300"},{"name":"type","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"schema_300"},{"name":"position_in_blueprints","in":"query","schemaId":"schema_300"},{"name":"position_in_device_settings","in":"query","schemaId":"schema_300"},{"name":"created_by","in":"query","schemaId":"schema_302"},{"name":"updated_by","in":"query","schemaId":"schema_302"},{"name":"limit","in":"query","schemaId":"schema_404"},{"name":"offset","in":"query","schemaId":"schema_405"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/v2/custom-actions/","href":"1_custom-actions-api/paths/~1v2~1custom-actions~1/get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}},"schemaId":"schema_406"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}},"schemaId":"schema_407"}],"pointer":"/paths/~1v2~1custom-actions~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_406","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_406"}}},{"code":"400","schemaId":"schema_407","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_407"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_custom-actions-api/paths/~1v2~1custom-actions~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/"},{"label":"/v2/custom-actions/","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1/post","routeSlug":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1/post","metadata":{"seo":{"title":"/v2/custom-actions/","description":"Create a new custom action"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/custom-actions/","isWebhook":false,"pointer":"/paths/~1v2~1custom-actions~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/custom-actions/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new custom action"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActionCreate"}},"schemaId":"components/schemas/CustomActionCreate","pointer":"/paths/~1v2~1custom-actions~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/custom-actions/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomActionCreate"}},"responseCodes":["201","400","409","500"],"pointer":"/v2/custom-actions/","href":"1_custom-actions-api/paths/~1v2~1custom-actions~1/post"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/CustomActionCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActionCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}},"schemaId":"schema_408"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409"},{"code":"409","description":"Conflict - Custom Action name already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411"}],"pointer":"/paths/~1v2~1custom-actions~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_408","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_408"}}},{"code":"400","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"409","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"500","schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_custom-actions-api/paths/~1v2~1custom-actions~1/post"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/"},{"label":"/v2/custom-actions/{custom_action_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/get","routeSlug":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/get","metadata":{"seo":{"title":"/v2/custom-actions/{custom_action_id}/","description":"Retrieve a custom action by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/custom-actions/{custom_action_id}/","isWebhook":false,"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/custom-actions/{custom_action_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a custom action by ID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_action_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/custom-actions/{custom_action_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"custom_action_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/v2/custom-actions/{custom_action_id}/","href":"1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412"},{"code":"404","description":"Custom Action not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"}],"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"404","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/{custom_action_id}/"},{"label":"/v2/custom-actions/{custom_action_id}/","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/put","routeSlug":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/put","metadata":{"seo":{"title":"/v2/custom-actions/{custom_action_id}/","description":"Update a custom action by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/custom-actions/{custom_action_id}/","isWebhook":false,"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/custom-actions/{custom_action_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a custom action by ID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_action_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActionUpdate"}},"schemaId":"components/schemas/CustomActionUpdate","pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/custom-actions/{custom_action_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"custom_action_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CustomActionUpdate"}},"responseCodes":["200","400","404","409","500"],"pointer":"/v2/custom-actions/{custom_action_id}/","href":"1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/put"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/CustomActionUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CustomActionUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412"},{"code":"400","description":"Bad Request (validation error or invalid state transition)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414"},{"code":"404","description":"Custom Action not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"},{"code":"409","description":"Conflict - Custom Action name already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411"}],"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_412"}}},{"code":"400","schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}}},{"code":"404","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}},{"code":"409","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"500","schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/put"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/{custom_action_id}/"},{"label":"/v2/custom-actions/{custom_action_id}/","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete","routeSlug":"/openapi/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete","metadata":{"seo":{"title":"/v2/custom-actions/{custom_action_id}/","description":"Delete a custom action by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/custom-actions/{custom_action_id}/","isWebhook":false,"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/custom-actions/{custom_action_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a custom action by ID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"custom_action_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/custom-actions/{custom_action_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"custom_action_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404","500"],"pointer":"/v2/custom-actions/{custom_action_id}/","href":"1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415"},{"code":"400","description":"Bad Request - Cannot delete active custom action","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414"},{"code":"404","description":"Custom Action not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411"}],"pointer":"/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400","schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}}},{"code":"404","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}},{"code":"500","schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/custom-actions/{custom_action_id}/"},{"label":"/v2/scripts/{script_id}/","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/1_custom-actions-api/paths/~1v2~1scripts~1{script_id}~1/get","routeSlug":"/openapi/1_custom-actions-api/paths/~1v2~1scripts~1{script_id}~1/get","metadata":{"seo":{"title":"/v2/scripts/{script_id}/","description":"Retrieve script content by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"/v2/scripts/{script_id}/","isWebhook":false,"pointer":"/paths/~1v2~1scripts~1{script_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"/v2/scripts/{script_id}/","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve script content by ID"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"script_id","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1scripts~1{script_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/scripts/{script_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"script_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","500"],"pointer":"/v2/scripts/{script_id}/","href":"1_custom-actions-api/paths/~1v2~1scripts~1{script_id}~1/get"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416"}},"schemaId":"schema_416"},{"code":"403","description":"Permission denied","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417"},{"code":"404","description":"Script not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}},"schemaId":"schema_411"}],"pointer":"/paths/~1v2~1scripts~1{script_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_416","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416"}}},{"code":"403","schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}}},{"code":"404","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}},{"code":"500","schemaId":"schema_411","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_411"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/1_custom-actions-api/paths/~1v2~1scripts~1{script_id}~1/get"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/v2/scripts/{script_id}/"}],"content":{"contentType":"group","meta":{"name":"1_Custom Actions API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Actions API","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage custom actions. Custom actions allow you to define custom scripts and commands that can be executed on Linux devices. Currently, only Linux platform is supported for custom actions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/custom-actions/","summary":"Retrieve all custom actions for the tenant","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_custom-actions-api/paths/~1v2~1custom-actions~1/get","deprecated":false},{"title":"/v2/custom-actions/","summary":"Create a new custom action","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_custom-actions-api/paths/~1v2~1custom-actions~1/post","deprecated":false},{"title":"/v2/custom-actions/{custom_action_id}/","summary":"Retrieve a custom action by ID","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/get","deprecated":false},{"title":"/v2/custom-actions/{custom_action_id}/","summary":"Update a custom action by ID","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/put","deprecated":false},{"title":"/v2/custom-actions/{custom_action_id}/","summary":"Delete a custom action by ID","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_custom-actions-api/paths/~1v2~1custom-actions~1{custom_action_id}~1/delete","deprecated":false},{"title":"/v2/scripts/{script_id}/","summary":"Retrieve script content by ID","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/1_custom-actions-api/paths/~1v2~1scripts~1{script_id}~1/get","deprecated":false}]}]}]}]}},{"type":"separator","label":"PIPELINES","content":null},{"type":"group","label":"System Status Code","link":"/openapi/2_system-status-code","routeSlug":"/openapi/2_system-status-code","items":[],"content":{"contentType":"group","meta":{"name":"2_System Status Code"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System Status Code","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System status code descriptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"900 (INTERNAL_REQUEST_SKIPPED) - Response code is used when a request is valid, but cannot be fulfilled."},"children":[]}]}]}]}]}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_system-status-code"}],"panels":[]}]}},{"type":"group","label":"System","link":"/openapi/2_system","routeSlug":"/openapi/2_system","items":[{"label":"Health check endpoint","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_system/getservicehealth","routeSlug":"/openapi/2_system/getservicehealth","metadata":{"seo":{"title":"Health check endpoint","description":"Health check endpoint"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServiceHealth","name":"Health check endpoint","isWebhook":false,"pointer":"/paths/~1sys~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health check endpoint","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sys/health","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/sys/health","href":"2_system/getservicehealth","openApiOperationId":"getServiceHealth","summary":"Health check endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pipelines health service response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Health"}},"schemaId":"components/schemas/Health"},{"code":"default","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1sys~1health/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Health","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Health"}}},{"code":"default","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_system/getservicehealth"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/sys/health"}],"content":{"contentType":"group","meta":{"name":"2_System"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"System","showPageActions":true},{"nodeType":"markdoc","content":"System level APIs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sys/health","summary":"Health check endpoint","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_system/getservicehealth","deprecated":false}]}]}]}]}},{"type":"group","label":"Pipelines","link":"/openapi/2_pipelines","routeSlug":"/openapi/2_pipelines","items":[{"label":"Get all Pipelines for the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipelines/getpipelines","routeSlug":"/openapi/2_pipelines/getpipelines","metadata":{"seo":{"title":"Get all Pipelines for the Enterprise","description":"Returns all the Pipelines that are not deleted"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelines","name":"Get all Pipelines for the Enterprise","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Pipelines for the Enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the Pipelines that are not deleted"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"default","in":"query","schemaId":"schema_418"},{"name":"name","in":"query","schemaId":"schema_300","description":"Filter by name"},{"name":"ordering","in":"query","schemaId":"schema_419","description":"Sorting pipelines based on the field name"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"default","in":"query","schemaId":"schema_418"},{"name":"name","in":"query","schemaId":"schema_300"},{"name":"ordering","in":"query","schemaId":"schema_419"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/pipelines/v0/pipelines/","href":"2_pipelines/getpipelines","openApiOperationId":"getPipelines","summary":"Get all Pipelines for the Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pipelines list for the Enterprise","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipelines/getpipelines"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/"},{"label":"Create a new Pipeline","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipelines/createpipeline","routeSlug":"/openapi/2_pipelines/createpipeline","metadata":{"seo":{"title":"Create a new Pipeline","description":"Create a Pipeline for the enterprise using logged in user token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPipeline","name":"Create a new Pipeline","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Pipeline","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a Pipeline for the enterprise using logged in user token"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pipeline_POST"}},"schemaId":"components/schemas/Pipeline_POST","pointer":"/paths/~1pipelines~1v0~1pipelines~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/pipelines/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pipeline_POST"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/pipelines/","href":"2_pipelines/createpipeline","openApiOperationId":"createPipeline","summary":"Create a new Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Pipeline_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pipeline_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421"},{"code":"400","description":"Pipelines create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Pipelines create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipelines/createpipeline"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/"},{"label":"Get a Pipeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipelines/getpipeline","routeSlug":"/openapi/2_pipelines/getpipeline","metadata":{"seo":{"title":"Get a Pipeline","description":"Get a Pipeline"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipeline","name":"Get a Pipeline","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Pipeline","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/","href":"2_pipelines/getpipeline","openApiOperationId":"getPipeline","summary":"Get a Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pipeline information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipelines/getpipeline"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/"},{"label":"Update a Pipeline","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipelines/updatepipeline","routeSlug":"/openapi/2_pipelines/updatepipeline","metadata":{"seo":{"title":"Update a Pipeline","description":"Update a Pipeline"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipeline","name":"Update a Pipeline","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Pipeline","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pipeline_PUT"}},"schemaId":"components/schemas/Pipeline_PUT","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/pipelines/{pipeline_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Pipeline_PUT"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/","href":"2_pipelines/updatepipeline","openApiOperationId":"updatePipeline","summary":"Update a Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Pipeline_PUT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Pipeline_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Pipeline Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421"},{"code":"400","description":"Pipelines update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Pipelines update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipelines/updatepipeline"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/"},{"label":"Delete a Pipeline","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipelines/deletepipeline","routeSlug":"/openapi/2_pipelines/deletepipeline","metadata":{"seo":{"title":"Delete a Pipeline","description":"Delete a Pipeline"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePipeline","name":"Delete a Pipeline","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Pipeline","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/pipelines/{pipeline_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/","href":"2_pipelines/deletepipeline","openApiOperationId":"deletePipeline","summary":"Delete a Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted Pipeline Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421"},{"code":"401","description":"Pipelines delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipelines/deletepipeline"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Pipelines"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pipelines","showPageActions":true},{"nodeType":"markdoc","content":"Pipelines composition APIs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/pipelines/","summary":"Get all Pipelines for the Enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipelines/getpipelines","deprecated":false},{"title":"/pipelines/v0/pipelines/","summary":"Create a new Pipeline","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipelines/createpipeline","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/","summary":"Get a Pipeline","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipelines/getpipeline","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/","summary":"Update a Pipeline","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipelines/updatepipeline","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/","summary":"Delete a Pipeline","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipelines/deletepipeline","deprecated":false}]}]}]}]}},{"type":"group","label":"Stages","link":"/openapi/2_stages","routeSlug":"/openapi/2_stages","items":[{"label":"Get all Pipeline stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/getpipelinestages","routeSlug":"/openapi/2_stages/getpipelinestages","metadata":{"seo":{"title":"Get all Pipeline stages","description":"Get all Pipeline stages"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineStages","name":"Get all Pipeline stages","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Pipeline stages","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/stages/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/stages/","href":"2_stages/getpipelinestages","openApiOperationId":"getPipelineStages","summary":"Get all Pipeline stages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pipelines stages response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}},"schemaId":"schema_422"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/getpipelinestages"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/"},{"label":"Create a Pipeline stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/createpipelinestage","routeSlug":"/openapi/2_stages/createpipelinestage","metadata":{"seo":{"title":"Create a Pipeline stage","description":"Create a Pipeline stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPipelineStage","name":"Create a Pipeline stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Pipeline stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Stage_POST"}},"schemaId":"components/schemas/Stage_POST","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/pipelines/{pipeline_id}/stages/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Stage_POST"}},"responseCodes":["200","400"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/stages/","href":"2_stages/createpipelinestage","openApiOperationId":"createPipelineStage","summary":"Create a Pipeline stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Stage_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Stage_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pipelines stages create response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"400","description":"Stage create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/createpipelinestage"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/"},{"label":"Get a Pipeline Stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/getpipelinestage","routeSlug":"/openapi/2_stages/getpipelinestage","metadata":{"seo":{"title":"Get a Pipeline Stage","description":"Get a Pipeline Stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineStage","name":"Get a Pipeline Stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Pipeline Stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","href":"2_stages/getpipelinestage","openApiOperationId":"getPipelineStage","summary":"Get a Pipeline Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pipelines stage get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/getpipelinestage"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/"},{"label":"Update a Pipeline Stage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/updatepipelinestage","routeSlug":"/openapi/2_stages/updatepipelinestage","metadata":{"seo":{"title":"Update a Pipeline Stage","description":"Update a Pipeline Stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipelineStage","name":"Update a Pipeline Stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Pipeline Stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Stage_PUT"}},"schemaId":"components/schemas/Stage_PUT","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Stage_PUT"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","href":"2_stages/updatepipelinestage","openApiOperationId":"updatePipelineStage","summary":"Update a Pipeline Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Stage_PUT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Stage_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Stage Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"400","description":"Stage update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Stage update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/updatepipelinestage"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/"},{"label":"Delete a pipeline stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/deletepipelinestage","routeSlug":"/openapi/2_stages/deletepipelinestage","metadata":{"seo":{"title":"Delete a pipeline stage","description":"Delete a pipeline stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePipelineStage","name":"Delete a pipeline stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a pipeline stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","href":"2_stages/deletepipelinestage","openApiOperationId":"deletePipelineStage","summary":"Delete a pipeline stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted Stage Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423"},{"code":"401","description":"Stage delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1stages~1{stage_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/deletepipelinestage"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/"},{"label":"Get all Target Lists attached to the Stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/getstagetargetlists","routeSlug":"/openapi/2_stages/getstagetargetlists","metadata":{"seo":{"title":"Get all Target Lists attached to the Stage","description":"Get all Target Lists attached to the Stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStageTargetLists","name":"Get all Target Lists attached to the Stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Target Lists attached to the Stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_id","in":"path","schemaId":"schema_299","description":"ID of the Stage","required":true}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_424"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/stages/{stage_id}/targetlists/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"type","in":"query","schemaId":"schema_424"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stages/{stage_id}/targetlists/","href":"2_stages/getstagetargetlists","openApiOperationId":"getStageTargetLists","summary":"Get all Target Lists attached to the Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Targets Lists attached to the Stage","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425"},{"code":"401","description":"Target List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/getstagetargetlists"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/targetlists/"},{"label":"Attach the Target List to the Stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/addstagetargetlist","routeSlug":"/openapi/2_stages/addstagetargetlist","metadata":{"seo":{"title":"Attach the Target List to the Stage","description":"Attach the Target List to the Stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addStageTargetList","name":"Attach the Target List to the Stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach the Target List to the Stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StageTargetList_POST"}},"schemaId":"components/schemas/StageTargetList_POST","pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/stages/{stage_id}/targetlists/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StageTargetList_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/stages/{stage_id}/targetlists/","href":"2_stages/addstagetargetlist","openApiOperationId":"addStageTargetList","summary":"Attach the Target List to the Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/StageTargetList_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StageTargetList_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attach target list to a Stage","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"401","description":"Target list attach error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/addstagetargetlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/targetlists/"},{"label":"Detach the Target List from the Stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stages/deletestagetargetlist","routeSlug":"/openapi/2_stages/deletestagetargetlist","metadata":{"seo":{"title":"Detach the Target List from the Stage","description":"Detach the Target List from the Stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStageTargetList","name":"Detach the Target List from the Stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1{targetlist_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detach the Target List from the Stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1{targetlist_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/stages/{stage_id}/targetlists/{targetlist_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stages/{stage_id}/targetlists/{targetlist_id}/","href":"2_stages/deletestagetargetlist","openApiOperationId":"deleteStageTargetList","summary":"Detach the Target List from the Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Detach target list from stage","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"401","description":"Target list attach error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1targetlists~1{targetlist_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stages/deletestagetargetlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/targetlists/{targetlist_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Stages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stages","showPageActions":true},{"nodeType":"markdoc","content":"APIs to modify Stage information"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/pipelines/{pipeline_id}/stages/","summary":"Get all Pipeline stages","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/getpipelinestages","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/stages/","summary":"Create a Pipeline stage","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/createpipelinestage","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","summary":"Get a Pipeline Stage","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/getpipelinestage","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","summary":"Update a Pipeline Stage","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/updatepipelinestage","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/","summary":"Delete a pipeline stage","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/deletepipelinestage","deprecated":false},{"title":"/pipelines/v0/stages/{stage_id}/targetlists/","summary":"Get all Target Lists attached to the Stage","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/getstagetargetlists","deprecated":false},{"title":"/pipelines/v0/stages/{stage_id}/targetlists/","summary":"Attach the Target List to the Stage","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/addstagetargetlist","deprecated":false},{"title":"/pipelines/v0/stages/{stage_id}/targetlists/{targetlist_id}/","summary":"Detach the Target List from the Stage","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stages/deletestagetargetlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Target Lists","link":"/openapi/2_target-lists","routeSlug":"/openapi/2_target-lists","items":[{"label":"Get all Target Lists in Pipeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-lists/getpipelinetargetlists","routeSlug":"/openapi/2_target-lists/getpipelinetargetlists","metadata":{"seo":{"title":"Get all Target Lists in Pipeline","description":"Get all Target Lists in Pipeline"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineTargetLists","name":"Get all Target Lists in Pipeline","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Target Lists in Pipeline","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/","href":"2_target-lists/getpipelinetargetlists","openApiOperationId":"getPipelineTargetLists","summary":"Get all Target Lists in Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Target Lists in Pipeline","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425"},{"code":"401","description":"Target List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-lists/getpipelinetargetlists"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/"},{"label":"Create a Target List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-lists/addpipelinetargetlist","routeSlug":"/openapi/2_target-lists/addpipelinetargetlist","metadata":{"seo":{"title":"Create a Target List","description":"Create a Target List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addPipelineTargetList","name":"Create a Target List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Target List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetList_POST"}},"schemaId":"components/schemas/TargetList_POST","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TargetList_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/","href":"2_target-lists/addpipelinetargetlist","openApiOperationId":"addPipelineTargetList","summary":"Create a Target List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/TargetList_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetList_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Targets in Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"401","description":"Target List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-lists/addpipelinetargetlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/"},{"label":"Get a Pipeline Target list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-lists/getpipelinetargetlist","routeSlug":"/openapi/2_target-lists/getpipelinetargetlist","metadata":{"seo":{"title":"Get a Pipeline Target list","description":"Get a Pipeline Target list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineTargetList","name":"Get a Pipeline Target list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Pipeline Target list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target list","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","href":"2_target-lists/getpipelinetargetlist","openApiOperationId":"getPipelineTargetList","summary":"Get a Pipeline Target list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get target list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"401","description":"Target list attach error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-lists/getpipelinetargetlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/"},{"label":"Update a Pipeline Target List","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-lists/updatepipelinetargetlist","routeSlug":"/openapi/2_target-lists/updatepipelinetargetlist","metadata":{"seo":{"title":"Update a Pipeline Target List","description":"Update a Pipeline Target List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipelineTargetList","name":"Update a Pipeline Target List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Pipeline Target List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetList"}},"schemaId":"components/schemas/TargetList","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TargetList"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","href":"2_target-lists/updatepipelinetargetlist","openApiOperationId":"updatePipelineTargetList","summary":"Update a Pipeline Target List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/TargetList","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetList"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Target List Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"400","description":"Target List update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Target List update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-lists/updatepipelinetargetlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/"},{"label":"Delete a Pipeline Target list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-lists/deletepipelinetargetlist","routeSlug":"/openapi/2_target-lists/deletepipelinetargetlist","metadata":{"seo":{"title":"Delete a Pipeline Target list","description":"Delete a Pipeline Target list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePipelineTargetList","name":"Delete a Pipeline Target list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Pipeline Target list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","href":"2_target-lists/deletepipelinetargetlist","openApiOperationId":"deletePipelineTargetList","summary":"Delete a Pipeline Target list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delete target list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426"},{"code":"401","description":"Target list delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-lists/deletepipelinetargetlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Target Lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Target Lists","showPageActions":true},{"nodeType":"markdoc","content":"APIs to modify Target List"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/","summary":"Get all Target Lists in Pipeline","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-lists/getpipelinetargetlists","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/","summary":"Create a Target List","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-lists/addpipelinetargetlist","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","summary":"Get a Pipeline Target list","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-lists/getpipelinetargetlist","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","summary":"Update a Pipeline Target List","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-lists/updatepipelinetargetlist","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/","summary":"Delete a Pipeline Target list","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-lists/deletepipelinetargetlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Targets","link":"/openapi/2_targets","routeSlug":"/openapi/2_targets","items":[{"label":"Get all Targets in the Target List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_targets/gettargetlisttargets","routeSlug":"/openapi/2_targets/gettargetlisttargets","metadata":{"seo":{"title":"Get all Targets in the Target List","description":"Get all Targets in the Target List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTargetListTargets","name":"Get all Targets in the Target List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Targets in the Target List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/","href":"2_targets/gettargetlisttargets","openApiOperationId":"getTargetListTargets","summary":"Get all Targets in the Target List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Targets in Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}},"schemaId":"schema_427"},{"code":"401","description":"Target List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_427","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_targets/gettargetlisttargets"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/"},{"label":"Create a target for the target list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_targets/createtargetlisttargets","routeSlug":"/openapi/2_targets/createtargetlisttargets","metadata":{"seo":{"title":"Create a target for the target list","description":"Create a target for the target list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTargetListTargets","name":"Create a target for the target list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a target for the target list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Target_POST"}},"schemaId":"components/schemas/Target_POST","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Target_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/","href":"2_targets/createtargetlisttargets","openApiOperationId":"createTargetListTargets","summary":"Create a target for the target list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Target_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Target_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Targets in Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}},"schemaId":"schema_428"},{"code":"401","description":"Target List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_targets/createtargetlisttargets"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/"},{"label":"Get one target from target list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_targets/gettargetlisttarget","routeSlug":"/openapi/2_targets/gettargetlisttarget","metadata":{"seo":{"title":"Get one target from target list","description":"Get one target from target list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTargetListTarget","name":"Get one target from target list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get one target from target list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_299","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_299","description":"ID of the Target List","required":true},{"name":"target_id","in":"path","schemaId":"schema_299","description":"ID of the Target","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"target_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","href":"2_targets/gettargetlisttarget","openApiOperationId":"getTargetListTarget","summary":"Get one target from target list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Target from Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}},"schemaId":"schema_428"},{"code":"401","description":"Target List device delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_targets/gettargetlisttarget"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/"},{"label":"Update a target in the target list","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_targets/updatetargetlisttarget","routeSlug":"/openapi/2_targets/updatetargetlisttarget","metadata":{"seo":{"title":"Update a target in the target list","description":"Update a target in the target list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTargetListTarget","name":"Update a target in the target list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a target in the target list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_299","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_299","description":"ID of the Target List","required":true},{"name":"target_id","in":"path","schemaId":"schema_299","description":"ID of the Target","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Target_PUT"}},"schemaId":"components/schemas/Target_PUT","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"target_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Target_PUT"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","href":"2_targets/updatetargetlisttarget","openApiOperationId":"updateTargetListTarget","summary":"Update a target in the target list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Target_PUT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Target_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Target from Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}},"schemaId":"schema_428"},{"code":"401","description":"Target List device delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_targets/updatetargetlisttarget"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/"},{"label":"Delete a Target or Device from a Target List","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_targets/deletetargetlisttarget","routeSlug":"/openapi/2_targets/deletetargetlisttarget","metadata":{"seo":{"title":"Delete a Target or Device from a Target List","description":"Delete a Target or Device from a Target List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTargetListTarget","name":"Delete a Target or Device from a Target List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Target or Device from a Target List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_299","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_299","description":"ID of the Target List","required":true},{"name":"target_id","in":"path","schemaId":"schema_299","description":"ID of the Target","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"target_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","href":"2_targets/deletetargetlisttarget","openApiOperationId":"deleteTargetListTarget","summary":"Delete a Target or Device from a Target List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted Target from Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}},"schemaId":"schema_428"},{"code":"401","description":"Target List device delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets~1{target_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_428","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_428"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_targets/deletetargetlisttarget"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/"},{"label":"Bulk add targets to a target list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_targets/bulkaddtargetlisttargets","routeSlug":"/openapi/2_targets/bulkaddtargetlisttargets","metadata":{"seo":{"title":"Bulk add targets to a target list","description":"Adds multiple targets to a target list. Creates target records if they don't exist, then links them to the target list. Existing targets in the list are left unchanged (skipped). Behaves the same as legacy /targets/ API. device_name should be provided for proper target run creation. device_alias can be provided as a direct property and will be stored in device_meta."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkAddTargetListTargets","name":"Bulk add targets to a target list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets-bulk~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk add targets to a target list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds multiple targets to a target list. Creates target records if they don't exist, then links them to the target list. Existing targets in the list are left unchanged (skipped). Behaves the same as legacy /targets/ API. device_name should be provided for proper target run creation. device_alias can be provided as a direct property and will be stored in device_meta."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_299","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_299","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets-bulk~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets-bulk~1/post/requestBody","description":"Array of device IDs (strings) or device objects with metadata"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets-bulk/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_429"}},"responseCodes":["200","400","401","500"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets-bulk/","href":"2_targets/bulkaddtargetlisttargets","openApiOperationId":"bulkAddTargetListTargets","summary":"Bulk add targets to a target list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_429"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Bulk add completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}},"schemaId":"schema_430"},{"code":"400","description":"Bad request - invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1targets-bulk~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_430","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_targets/bulkaddtargetlisttargets"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets-bulk/"}],"content":{"contentType":"group","meta":{"name":"2_Targets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Targets","showPageActions":true},{"nodeType":"markdoc","content":"Targets subsystem"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/","summary":"Get all Targets in the Target List","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_targets/gettargetlisttargets","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/","summary":"Create a target for the target list","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_targets/createtargetlisttargets","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","summary":"Get one target from target list","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_targets/gettargetlisttarget","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","summary":"Update a target in the target list","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_targets/updatetargetlisttarget","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/","summary":"Delete a Target or Device from a Target List","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_targets/deletetargetlisttarget","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets-bulk/","summary":"Bulk add targets to a target list","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_targets/bulkaddtargetlisttargets","deprecated":false}]}]}]}]}},{"type":"group","label":"Device Groups","link":"/openapi/2_device-groups","routeSlug":"/openapi/2_device-groups","items":[{"label":"Get all Device Groups in the Target List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_device-groups/gettargetlistdevicegroups","routeSlug":"/openapi/2_device-groups/gettargetlistdevicegroups","metadata":{"seo":{"title":"Get all Device Groups in the Target List","description":"Get all Device Groups in the Target List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTargetListDeviceGroups","name":"Get all Device Groups in the Target List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Device Groups in the Target List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/","href":"2_device-groups/gettargetlistdevicegroups","openApiOperationId":"getTargetListDeviceGroups","summary":"Get all Device Groups in the Target List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Device Groups in Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}},"schemaId":"schema_431"},{"code":"401","description":"Target List device group get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_431","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_device-groups/gettargetlistdevicegroups"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/"},{"label":"Add a Device Group to the Target List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_device-groups/addtargetlistdevicegroups","routeSlug":"/openapi/2_device-groups/addtargetlistdevicegroups","metadata":{"seo":{"title":"Add a Device Group to the Target List","description":"Add a Device Group to the Target List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addTargetListDeviceGroups","name":"Add a Device Group to the Target List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a Device Group to the Target List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_300","description":"ID of the Target List","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetListDeviceGroups_POST"}},"schemaId":"components/schemas/TargetListDeviceGroups_POST","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TargetListDeviceGroups_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/","href":"2_device-groups/addtargetlistdevicegroups","openApiOperationId":"addTargetListDeviceGroups","summary":"Add a Device Group to the Target List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/TargetListDeviceGroups_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetListDeviceGroups_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Added Device group","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TargetListDeviceGroup"}},"schemaId":"components/schemas/TargetListDeviceGroup"},{"code":"401","description":"Target List Device Group add error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TargetListDeviceGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TargetListDeviceGroup"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_device-groups/addtargetlistdevicegroups"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/"},{"label":"Delete Device Group from a Target List","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_device-groups/deletetargetlistdevicegroup","routeSlug":"/openapi/2_device-groups/deletetargetlistdevicegroup","metadata":{"seo":{"title":"Delete Device Group from a Target List","description":"Delete Device Group from a Target List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTargetListDeviceGroup","name":"Delete Device Group from a Target List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1{devicegroup_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Device Group from a Target List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_299","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_299","description":"ID of the Target List","required":true},{"name":"devicegroup_id","in":"path","schemaId":"schema_299","description":"ID of the Device Group","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1{devicegroup_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{devicegroup_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"devicegroup_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{devicegroup_id}/","href":"2_device-groups/deletetargetlistdevicegroup","openApiOperationId":"deleteTargetListDeviceGroup","summary":"Delete Device Group from a Target List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted Device Group from Target List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}},"schemaId":"schema_432"},{"code":"401","description":"Target List device delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1{devicegroup_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_432","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_device-groups/deletetargetlistdevicegroup"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{devicegroup_id}/"},{"label":"Get all Devices in the device group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_device-groups/getdevicegroupdevices","routeSlug":"/openapi/2_device-groups/getdevicegroupdevices","metadata":{"seo":{"title":"Get all Devices in the device group","description":"Get all Devices in the device group"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceGroupDevices","name":"Get all Devices in the device group","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1{device_group_id}~1devices~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Devices in the device group","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_299","description":"ID of the Pipeline","required":true},{"name":"targetlist_id","in":"path","schemaId":"schema_299","description":"ID of the Target List","required":true},{"name":"device_group_id","in":"path","schemaId":"schema_299","description":"ID of the Device Group","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1{device_group_id}~1devices~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{device_group_id}/devices/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"targetlist_id","in":"path","required":true,"schemaId":"schema_299"},{"name":"device_group_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{device_group_id}/devices/","href":"2_device-groups/getdevicegroupdevices","openApiOperationId":"getDeviceGroupDevices","summary":"Get all Devices in the device group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Devices in Device group","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_433"}},"schemaId":"schema_433"},{"code":"401","description":"Operation List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1targetlists~1{targetlist_id}~1devicegroups~1{device_group_id}~1devices~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_433","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_433"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_device-groups/getdevicegroupdevices"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{device_group_id}/devices/"}],"content":{"contentType":"group","meta":{"name":"2_Device Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Groups","showPageActions":true},{"nodeType":"markdoc","content":"APIs to modify Device Groups"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/","summary":"Get all Device Groups in the Target List","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_device-groups/gettargetlistdevicegroups","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/","summary":"Add a Device Group to the Target List","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_device-groups/addtargetlistdevicegroups","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{devicegroup_id}/","summary":"Delete Device Group from a Target List","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_device-groups/deletetargetlistdevicegroup","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/{device_group_id}/devices/","summary":"Get all Devices in the device group","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_device-groups/getdevicegroupdevices","deprecated":false}]}]}]}]}},{"type":"group","label":"Operation Lists","link":"/openapi/2_operation-lists","routeSlug":"/openapi/2_operation-lists","items":[{"label":"Get all Operation Lists attached to the Stage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operation-lists/getstageoperationlists","routeSlug":"/openapi/2_operation-lists/getstageoperationlists","metadata":{"seo":{"title":"Get all Operation Lists attached to the Stage","description":"Get all Operation Lists attached to the Stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStageOperationLists","name":"Get all Operation Lists attached to the Stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Operation Lists attached to the Stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/stages/{stage_id}/operationlists/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stages/{stage_id}/operationlists/","href":"2_operation-lists/getstageoperationlists","openApiOperationId":"getStageOperationLists","summary":"Get all Operation Lists attached to the Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Operation Lists attached to the Stage","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434"},{"code":"401","description":"Operation List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operation-lists/getstageoperationlists"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/"},{"label":"Create an Operation list for the Stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operation-lists/addstageoperationlist","routeSlug":"/openapi/2_operation-lists/addstageoperationlist","metadata":{"seo":{"title":"Create an Operation list for the Stage","description":"Create an Operation list for the Stage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addStageOperationList","name":"Create an Operation list for the Stage","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Operation list for the Stage","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OperationList_POST"}},"schemaId":"components/schemas/OperationList_POST","pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/stages/{stage_id}/operationlists/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OperationList_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/stages/{stage_id}/operationlists/","href":"2_operation-lists/addstageoperationlist","openApiOperationId":"addStageOperationList","summary":"Create an Operation list for the Stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/OperationList_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OperationList_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attach Operation list to a Stage","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435"},{"code":"401","description":"Operation list attach error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operation-lists/addstageoperationlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/"},{"label":"Update an Operation List","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operation-lists/updatepipelineoperationlist","routeSlug":"/openapi/2_operation-lists/updatepipelineoperationlist","metadata":{"seo":{"title":"Update an Operation List","description":"Update an Operation List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipelineOperationList","name":"Update an Operation List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1{operationlist_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an Operation List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true},{"name":"operationlist_id","in":"path","schemaId":"schema_300","description":"ID of the Operation List","required":true}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1{operationlist_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OperationList"}},"schemaId":"components/schemas/OperationList","pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1{operationlist_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"operationlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OperationList"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/","href":"2_operation-lists/updatepipelineoperationlist","openApiOperationId":"updatePipelineOperationList","summary":"Update an Operation List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/OperationList","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OperationList"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Operation List Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435"},{"code":"400","description":"Operation List update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Operation List update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1{operationlist_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operation-lists/updatepipelineoperationlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/"},{"label":"Delete stage operation list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operation-lists/deletestageoperationlist","routeSlug":"/openapi/2_operation-lists/deletestageoperationlist","metadata":{"seo":{"title":"Delete stage operation list","description":"Delete stage operation list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStageOperationList","name":"Delete stage operation list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1{operationlist_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete stage operation list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_id","in":"path","schemaId":"schema_300","description":"ID of the Stage","required":true},{"name":"operationlist_id","in":"path","schemaId":"schema_300","description":"ID of the Operation List","required":true}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1{operationlist_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"operationlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/","href":"2_operation-lists/deletestageoperationlist","openApiOperationId":"deleteStageOperationList","summary":"Delete stage operation list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delete operation list from stage","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435"},{"code":"401","description":"Operation list detach error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stages~1{stage_id}~1operationlists~1{operationlist_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operation-lists/deletestageoperationlist"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Operation Lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operation Lists","showPageActions":true},{"nodeType":"markdoc","content":"APIs to modify Operation List"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/stages/{stage_id}/operationlists/","summary":"Get all Operation Lists attached to the Stage","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operation-lists/getstageoperationlists","deprecated":false},{"title":"/pipelines/v0/stages/{stage_id}/operationlists/","summary":"Create an Operation list for the Stage","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operation-lists/addstageoperationlist","deprecated":false},{"title":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/","summary":"Update an Operation List","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operation-lists/updatepipelineoperationlist","deprecated":false},{"title":"/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/","summary":"Delete stage operation list","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operation-lists/deletestageoperationlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Operations","link":"/openapi/2_operations","routeSlug":"/openapi/2_operations","items":[{"label":"Get all Operations in the Operation List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operations/getoperationlistoperations","routeSlug":"/openapi/2_operations/getoperationlistoperations","metadata":{"seo":{"title":"Get all Operations in the Operation List","description":"Get all Operations in the Operation List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOperationListOperations","name":"Get all Operations in the Operation List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Operations in the Operation List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationlist_id","in":"path","schemaId":"schema_300","description":"ID of the Operation List","required":true}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"operation_type","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operation Type to filter on as defined in Operation_POST model"},"children":[]}]}]}]}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/operationlists/{operationlist_id}/operations/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"operation_type","in":"query","required":false,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/operationlists/{operationlist_id}/operations/","href":"2_operations/getoperationlistoperations","openApiOperationId":"getOperationListOperations","summary":"Get all Operations in the Operation List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Operations in Operation List","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436"},{"code":"401","description":"Operation List get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operations/getoperationlistoperations"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/"},{"label":"Create an Operation for Operation List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operations/addoperationlistoperations","routeSlug":"/openapi/2_operations/addoperationlistoperations","metadata":{"seo":{"title":"Create an Operation for Operation List","description":"Create an Operation for Operation List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addOperationListOperations","name":"Create an Operation for Operation List","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Operation for Operation List","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationlist_id","in":"path","schemaId":"schema_300","description":"ID of the Operation List","required":true}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Operation_POST"}},"schemaId":"components/schemas/Operation_POST","pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/operationlists/{operationlist_id}/operations/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationlist_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Operation_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/operationlists/{operationlist_id}/operations/","href":"2_operations/addoperationlistoperations","openApiOperationId":"addOperationListOperations","summary":"Create an Operation for Operation List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Operation_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Operation_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"401","description":"Operation create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operations/addoperationlistoperations"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/"},{"label":"Get an Operation from the operation list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operations/getoperationlistoperation","routeSlug":"/openapi/2_operations/getoperationlistoperation","metadata":{"seo":{"title":"Get an Operation from the operation list","description":"Get an Operation from the operation list"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOperationListOperation","name":"Get an Operation from the operation list","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an Operation from the operation list","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationlist_id","in":"path","schemaId":"schema_300","description":"ID of the Operation list","required":true},{"name":"operation_id","in":"path","schemaId":"schema_300","description":"ID of the Operation","required":true}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationlist_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"operation_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","href":"2_operations/getoperationlistoperation","openApiOperationId":"getOperationListOperation","summary":"Get an Operation from the operation list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get operation from operation list","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"401","description":"Operation get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operations/getoperationlistoperation"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/"},{"label":"Update an Operation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operations/updateoperationlistoperation","routeSlug":"/openapi/2_operations/updateoperationlistoperation","metadata":{"seo":{"title":"Update an Operation","description":"Update an Operation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOperationListOperation","name":"Update an Operation","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an Operation","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationlist_id","in":"path","schemaId":"schema_300","description":"ID of the Operation List","required":true},{"name":"operation_id","in":"path","schemaId":"schema_300","description":"ID of the Operation","required":true}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Operation"}},"schemaId":"components/schemas/Operation","pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationlist_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"operation_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Operation"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","href":"2_operations/updateoperationlistoperation","openApiOperationId":"updateOperationListOperation","summary":"Update an Operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Operation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Operation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Operation Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"400","description":"Operation update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Operation update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operations/updateoperationlistoperation"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/"},{"label":"Delete an Operation list operation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_operations/deleteoperationlistoperation","routeSlug":"/openapi/2_operations/deleteoperationlistoperation","metadata":{"seo":{"title":"Delete an Operation list operation","description":"Delete an Operation list operation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOperationListOperation","name":"Delete an Operation list operation","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an Operation list operation","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationlist_id","in":"path","schemaId":"schema_300","description":"ID of the Operation List","required":true},{"name":"operation_id","in":"path","schemaId":"schema_300","description":"ID of the Operation","required":true}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationlist_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"operation_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","href":"2_operations/deleteoperationlistoperation","openApiOperationId":"deleteOperationListOperation","summary":"Delete an Operation list operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Delete operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437"},{"code":"401","description":"Operation delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1operationlists~1{operationlist_id}~1operations~1{operation_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_operations/deleteoperationlistoperation"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operations","showPageActions":true},{"nodeType":"markdoc","content":"Operations subsystem"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/operationlists/{operationlist_id}/operations/","summary":"Get all Operations in the Operation List","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operations/getoperationlistoperations","deprecated":false},{"title":"/pipelines/v0/operationlists/{operationlist_id}/operations/","summary":"Create an Operation for Operation List","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operations/addoperationlistoperations","deprecated":false},{"title":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","summary":"Get an Operation from the operation list","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operations/getoperationlistoperation","deprecated":false},{"title":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","summary":"Update an Operation","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operations/updateoperationlistoperation","deprecated":false},{"title":"/pipelines/v0/operationlists/{operationlist_id}/operations/{operation_id}/","summary":"Delete an Operation list operation","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_operations/deleteoperationlistoperation","deprecated":false}]}]}]}]}},{"type":"group","label":"Pipeline Runs","link":"/openapi/2_pipeline-runs","routeSlug":"/openapi/2_pipeline-runs","items":[{"label":"Get all Runs for the Pipelines in the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipeline-runs/getallpipelineruns","routeSlug":"/openapi/2_pipeline-runs/getallpipelineruns","metadata":{"seo":{"title":"Get all Runs for the Pipelines in the Enterprise","description":"Get all Runs for the Pipelines in the Enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllPipelineRuns","name":"Get all Runs for the Pipelines in the Enterprise","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1runs~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Runs for the Pipelines in the Enterprise","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_438","description":"Filter by pipeline run status"},{"name":"pipeline_name","in":"query","schemaId":"schema_300","description":"Filter by pipeline name"},{"name":"ordering","in":"query","schemaId":"schema_439","description":"Sorting pipelines runs based on the field name"}],"pointer":"/paths/~1pipelines~1v0~1runs~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/runs/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"status","in":"query","schemaId":"schema_438"},{"name":"pipeline_name","in":"query","schemaId":"schema_300"},{"name":"ordering","in":"query","schemaId":"schema_439"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/runs/","href":"2_pipeline-runs/getallpipelineruns","openApiOperationId":"getAllPipelineRuns","summary":"Get all Runs for the Pipelines in the Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Runs for the Pipelines in the Enterprise","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"},{"code":"401","description":"Pipeline run get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1runs~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipeline-runs/getallpipelineruns"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/"},{"label":"Get all Runs for the Pipeline","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipeline-runs/getpipelineruns","routeSlug":"/openapi/2_pipeline-runs/getpipelineruns","metadata":{"seo":{"title":"Get all Runs for the Pipeline","description":"Get all Runs for the Pipeline"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineRuns","name":"Get all Runs for the Pipeline","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Runs for the Pipeline","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_438","description":"Filter by pipeline run status"},{"name":"ordering","in":"query","schemaId":"schema_441","description":"Sorting pipelines runs based on the field name"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/runs/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"status","in":"query","schemaId":"schema_438"},{"name":"ordering","in":"query","schemaId":"schema_441"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/runs/","href":"2_pipeline-runs/getpipelineruns","openApiOperationId":"getPipelineRuns","summary":"Get all Runs for the Pipeline"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Runs for the Pipeline","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440"},{"code":"401","description":"Pipeline run get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipeline-runs/getpipelineruns"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/"},{"label":"Create a Pipeline Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipeline-runs/createpipelinerun","routeSlug":"/openapi/2_pipeline-runs/createpipelinerun","metadata":{"seo":{"title":"Create a Pipeline Run","description":"Create a Pipeline Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPipelineRun","name":"Create a Pipeline Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Pipeline Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"schemaId":"components/schemas/PipelineRun_POST","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/pipelines/{pipeline_id}/runs/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/runs/","href":"2_pipeline-runs/createpipelinerun","openApiOperationId":"createPipelineRun","summary":"Create a Pipeline Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/PipelineRun_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created Pipeline Run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442"},{"code":"401","description":"Pipeline run create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipeline-runs/createpipelinerun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/"},{"label":"Get Pipeline run by pipeline run id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipeline-runs/getpipelinerun","routeSlug":"/openapi/2_pipeline-runs/getpipelinerun","metadata":{"seo":{"title":"Get Pipeline run by pipeline run id","description":"Get Pipeline run by pipeline run id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineRun","name":"Get Pipeline run by pipeline run id","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pipeline run by pipeline run id","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"pipeline_run_id","in":"path","schemaId":"schema_300","description":"Run Id of pipeline run","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"pipeline_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","href":"2_pipeline-runs/getpipelinerun","openApiOperationId":"getPipelineRun","summary":"Get Pipeline run by pipeline run id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get Pipeline run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442"},{"code":"401","description":"Operation get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipeline-runs/getpipelinerun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/"},{"label":"Update a Pipeline Run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipeline-runs/updatepipelinerun","routeSlug":"/openapi/2_pipeline-runs/updatepipelinerun","metadata":{"seo":{"title":"Update a Pipeline Run","description":"Update a Pipeline Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipelineRun","name":"Update a Pipeline Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Pipeline Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"pipeline_run_id","in":"path","schemaId":"schema_300","description":"Run id of pipeline run","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_PUT"}},"schemaId":"components/schemas/PipelineRun_PUT","pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"pipeline_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PipelineRun_PUT"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","href":"2_pipeline-runs/updatepipelinerun","openApiOperationId":"updatePipelineRun","summary":"Update a Pipeline Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/PipelineRun_PUT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Pipeline run information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442"},{"code":"400","description":"Pipeline Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Pipeline Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipeline-runs/updatepipelinerun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/"},{"label":"Delete a Pipeline Run","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_pipeline-runs/deletepipelinerun","routeSlug":"/openapi/2_pipeline-runs/deletepipelinerun","metadata":{"seo":{"title":"Delete a Pipeline Run","description":"Delete a Pipeline Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePipelineRun","name":"Delete a Pipeline Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Pipeline Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline","required":true},{"name":"pipeline_run_id","in":"path","schemaId":"schema_300","description":"Run id of pipeline run","required":true}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"pipeline_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","href":"2_pipeline-runs/deletepipelinerun","openApiOperationId":"deletePipelineRun","summary":"Delete a Pipeline Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deleted Pipeline run information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}},"schemaId":"schema_442"},{"code":"400","description":"Pipeline Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Pipeline Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1pipelines~1{pipeline_id}~1runs~1{pipeline_run_id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_442"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_pipeline-runs/deletepipelinerun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Pipeline Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pipeline Runs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to manage Pipeline Runs. Pipeline run status descriptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Pipeline run created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUEUED - Pipeline run queued for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Pipeline run received by scheduler for processing. (Processing a pipeline involves performing the operations required before starting a pipeline)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUNNING - Pipeline run has started running."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WAITING -  Pipeline run is waiting for an action (manual/automatic)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETE - The pipeline run has completed processing i.e. All stage runs are processed. A complete pipeline run can move to success or failure."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUCCESS - A completed pipeline run moves to success if all stage runs are successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILURE - A completed pipeline run moves to failure if all stage runs are not successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Pipeline run is cancelled by the user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TIMEOUT -  The pipeline run has a timed out. This happens when the pipeline has not completed processing even after the timeout period (Default 21 days)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID - A pipeline run moves to invalid state when Pipeline run has no stageruns i.e pipeline has zero stages."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/runs/","summary":"Get all Runs for the Pipelines in the Enterprise","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipeline-runs/getallpipelineruns","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/runs/","summary":"Get all Runs for the Pipeline","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipeline-runs/getpipelineruns","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/runs/","summary":"Create a Pipeline Run","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipeline-runs/createpipelinerun","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","summary":"Get Pipeline run by pipeline run id","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipeline-runs/getpipelinerun","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","summary":"Update a Pipeline Run","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipeline-runs/updatepipelinerun","deprecated":false},{"title":"/pipelines/v0/pipelines/{pipeline_id}/runs/{pipeline_run_id}/","summary":"Delete a Pipeline Run","prefix":{"name":"delete","color":"delete"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_pipeline-runs/deletepipelinerun","deprecated":false}]}]}]}]}},{"type":"group","label":"Stage Runs","link":"/openapi/2_stage-runs","routeSlug":"/openapi/2_stage-runs","items":[{"label":"Get all Stage Runs for the Pipeline Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stage-runs/getpipelinerunstageruns","routeSlug":"/openapi/2_stage-runs/getpipelinerunstageruns","metadata":{"seo":{"title":"Get all Stage Runs for the Pipeline Run","description":"Get all Stage Runs for the Pipeline Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineRunStageRuns","name":"Get all Stage Runs for the Pipeline Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Stage Runs for the Pipeline Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_run_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline Run","required":true}],"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_443","description":"Status of stage run"}],"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"status","in":"query","required":false,"schemaId":"schema_443"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/","href":"2_stage-runs/getpipelinerunstageruns","openApiOperationId":"getPipelineRunStageRuns","summary":"Get all Stage Runs for the Pipeline Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Stage Runs for the Pipeline Run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444"},{"code":"401","description":"Stage run get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stage-runs/getpipelinerunstageruns"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/"},{"label":"Get Pipeline Stage run by stage run Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stage-runs/getpipelinerunstagerun","routeSlug":"/openapi/2_stage-runs/getpipelinerunstagerun","metadata":{"seo":{"title":"Get Pipeline Stage run by stage run Id","description":"Get Pipeline Stage run by stage run Id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineRunStageRun","name":"Get Pipeline Stage run by stage run Id","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1{stage_run_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Pipeline Stage run by stage run Id","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_run_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline Run","required":true},{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"ID of pipeline stage run","required":true}],"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1{stage_run_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/","href":"2_stage-runs/getpipelinerunstagerun","openApiOperationId":"getPipelineRunStageRun","summary":"Get Pipeline Stage run by stage run Id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get pipeline run stage run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445"},{"code":"401","description":"Operation get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1{stage_run_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stage-runs/getpipelinerunstagerun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/"},{"label":"Update a Pipeline Stage Run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stage-runs/updatepipelinerunstagerun","routeSlug":"/openapi/2_stage-runs/updatepipelinerunstagerun","metadata":{"seo":{"title":"Update a Pipeline Stage Run","description":"Update a Pipeline Stage Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipelineRunStageRun","name":"Update a Pipeline Stage Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1{stage_run_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Pipeline Stage Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"pipeline_run_id","in":"path","schemaId":"schema_300","description":"ID of the Pipeline Run","required":true},{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"id of pipeline stage run","required":true}],"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1{stage_run_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446","pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1{stage_run_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"pipeline_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_446"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/","href":"2_stage-runs/updatepipelinerunstagerun","openApiOperationId":"updatePipelineRunStageRun","summary":"Update a Pipeline Stage Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_446"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Pipeline Stage run information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445"},{"code":"400","description":"Pipeline Stage Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Pipeline Stage Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1runs~1{pipeline_run_id}~1stageruns~1{stage_run_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stage-runs/updatepipelinerunstagerun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/"},{"label":"Get all Operations for the Stage Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stage-runs/getpipelinestagerunoperations","routeSlug":"/openapi/2_stage-runs/getpipelinestagerunoperations","metadata":{"seo":{"title":"Get all Operations for the Stage Run","description":"Get all Operations for the Stage Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineStageRunOperations","name":"Get all Operations for the Stage Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1operations~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Operations for the Stage Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"Stage run Id","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1operations~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/stageruns/{stage_run_id}/operations/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/operations/","href":"2_stage-runs/getpipelinestagerunoperations","openApiOperationId":"getPipelineStageRunOperations","summary":"Get all Operations for the Stage Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Operations for the Stage Run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447"},{"code":"401","description":"Stage run operation get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1operations~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stage-runs/getpipelinestagerunoperations"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/operations/"},{"label":"Get single Operation for the Stage Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_stage-runs/getpipelinestagerunoperation","routeSlug":"/openapi/2_stage-runs/getpipelinestagerunoperation","metadata":{"seo":{"title":"Get single Operation for the Stage Run","description":"Get single Operation for the Stage Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineStageRunOperation","name":"Get single Operation for the Stage Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1operations~1{stage_run_operation_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get single Operation for the Stage Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"Stage run Id","required":true},{"name":"stage_run_operation_id","in":"path","schemaId":"schema_300","description":"Stage run operation Id","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1operations~1{stage_run_operation_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/stageruns/{stage_run_id}/operations/{stage_run_operation_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"stage_run_operation_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/operations/{stage_run_operation_id}/","href":"2_stage-runs/getpipelinestagerunoperation","openApiOperationId":"getPipelineStageRunOperation","summary":"Get single Operation for the Stage Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operation for the Stage Run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}},"schemaId":"schema_448"},{"code":"401","description":"Stage run operation get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1operations~1{stage_run_operation_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_448","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_stage-runs/getpipelinestagerunoperation"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/operations/{stage_run_operation_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Stage Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stage Runs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to manage Stage Runs. Stage run status descriptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Stage run created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUEUED - Stage run queued for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Stage run received by scheduler for processing.(Processing a stage run can involve performing the operations required before starting a stage run. In this case creating the target runs for the stage.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUNNING - Stage run has started running."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETE - Stage run moves to complete if all target runs are complete (target runs are complete if they are in a terminal state)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUCCESS - A completed stage run moves to success if all target runs are successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILURE - A completed stage moves to failure if all target runs are not successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Stage run cancelled by user."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TIMEOUT - The stage run has a timed out. This happens when the stage run has not completed processing even after the timeout period (Default 7 days)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID -  A stage run moves to invalid state when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a. The associated stage has no targets."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"b. The associated stage has no operations."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/","summary":"Get all Stage Runs for the Pipeline Run","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stage-runs/getpipelinerunstageruns","deprecated":false},{"title":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/","summary":"Get Pipeline Stage run by stage run Id","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stage-runs/getpipelinerunstagerun","deprecated":false},{"title":"/pipelines/v0/runs/{pipeline_run_id}/stageruns/{stage_run_id}/","summary":"Update a Pipeline Stage Run","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stage-runs/updatepipelinerunstagerun","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/operations/","summary":"Get all Operations for the Stage Run","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stage-runs/getpipelinestagerunoperations","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/operations/{stage_run_operation_id}/","summary":"Get single Operation for the Stage Run","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_stage-runs/getpipelinestagerunoperation","deprecated":false}]}]}]}]}},{"type":"group","label":"Target Runs","link":"/openapi/2_target-runs","routeSlug":"/openapi/2_target-runs","items":[{"label":"Get all Target Runs for the Stage Run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-runs/getpipelinestagetargetruns","routeSlug":"/openapi/2_target-runs/getpipelinestagetargetruns","metadata":{"seo":{"title":"Get all Target Runs for the Stage Run","description":"Get all Target Runs for the Stage Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineStageTargetRuns","name":"Get all Target Runs for the Stage Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Target Runs for the Stage Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"Stage run Id","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"status","in":"query","schemaId":"schema_449","description":"Status of target run"},{"name":"stage_run_operation_id","in":"query","schemaId":"schema_299","description":"Stage run Operation Id to filter on"},{"name":"ordering","in":"query","schemaId":"schema_450","description":"Sorting target runs based on status field"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"status","in":"query","schemaId":"schema_449"},{"name":"stage_run_operation_id","in":"query","schemaId":"schema_299"},{"name":"ordering","in":"query","schemaId":"schema_450"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/","href":"2_target-runs/getpipelinestagetargetruns","openApiOperationId":"getPipelineStageTargetRuns","summary":"Get all Target Runs for the Stage Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All Target runs for the Stage Run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451"},{"code":"401","description":"Target run get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-runs/getpipelinestagetargetruns"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/"},{"label":"Create a Target Runs for Stage Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-runs/createpipelinestagetargetruns","routeSlug":"/openapi/2_target-runs/createpipelinestagetargetruns","metadata":{"seo":{"title":"Create a Target Runs for Stage Run","description":"Create a Target Runs for Stage Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPipelineStageTargetRuns","name":"Create a Target Runs for Stage Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Target Runs for Stage Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"Stage run Id","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetRun_POST"}},"schemaId":"components/schemas/TargetRun_POST","pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TargetRun_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/","href":"2_target-runs/createpipelinestagetargetruns","openApiOperationId":"createPipelineStageTargetRuns","summary":"Create a Target Runs for Stage Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/TargetRun_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetRun_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created Target Runs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}},"schemaId":"schema_452"},{"code":"401","description":"Target Run create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_452","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-runs/createpipelinestagetargetruns"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/"},{"label":"Get Target Run by Target Run ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-runs/getpipelinestagetargetrun","routeSlug":"/openapi/2_target-runs/getpipelinestagetargetrun","metadata":{"seo":{"title":"Get Target Run by Target Run ID","description":"Get Target Run by Target Run ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPipelineStageTargetRun","name":"Get Target Run by Target Run ID","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Target Run by Target Run ID","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"Stage run Id","required":true},{"name":"target_run_id","in":"path","schemaId":"schema_300","description":"Id of the Target Run","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"target_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/","href":"2_target-runs/getpipelinestagetargetrun","openApiOperationId":"getPipelineStageTargetRun","summary":"Get Target Run by Target Run ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get target run","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453"},{"code":"401","description":"Operation get error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-runs/getpipelinestagetargetrun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/"},{"label":"Update a Target Run","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-runs/updatepipelinestagetargetrun","routeSlug":"/openapi/2_target-runs/updatepipelinestagetargetrun","metadata":{"seo":{"title":"Update a Target Run","description":"Update a Target Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipelineStageTargetRun","name":"Update a Target Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Target Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"Stage run Id","required":true},{"name":"target_run_id","in":"path","schemaId":"schema_300","description":"Id of the target run","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetRun_PUT"}},"schemaId":"components/schemas/TargetRun_PUT","pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"target_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TargetRun_PUT"}},"responseCodes":["200","400","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/","href":"2_target-runs/updatepipelinestagetargetrun","openApiOperationId":"updatePipelineStageTargetRun","summary":"Update a Target Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/TargetRun_PUT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TargetRun_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated Target Run run information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453"},{"code":"400","description":"Target Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Target Run update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-runs/updatepipelinestagetargetrun"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/"},{"label":"Get status of the command running for Target run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-runs/gettargetruncommandstatus","routeSlug":"/openapi/2_target-runs/gettargetruncommandstatus","metadata":{"seo":{"title":"Get status of the command running for Target run","description":"Get status of the command running for Target run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTargetRunCommandStatus","name":"Get status of the command running for Target run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get status of the command running for Target run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"ID of the stage run","required":true},{"name":"target_run_id","in":"path","schemaId":"schema_300","description":"Id of the target run","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"target_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/","href":"2_target-runs/gettargetruncommandstatus","openApiOperationId":"getTargetRunCommandStatus","summary":"Get status of the command running for Target run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Command processor request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"401","description":"Command request create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-runs/gettargetruncommandstatus"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/"},{"label":"Create an command processor request for Target Run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-runs/createtargetruncommand","routeSlug":"/openapi/2_target-runs/createtargetruncommand","metadata":{"seo":{"title":"Create an command processor request for Target Run","description":"Create an command processor request for Target Run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTargetRunCommand","name":"Create an command processor request for Target Run","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an command processor request for Target Run","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"ID of the stage run","required":true},{"name":"target_run_id","in":"path","schemaId":"schema_300","description":"Id of the target run","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"schemaId":"components/schemas/PipelineRun_POST","pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"target_run_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"responseCodes":["200","401"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/","href":"2_target-runs/createtargetruncommand","openApiOperationId":"createTargetRunCommand","summary":"Create an command processor request for Target Run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/PipelineRun_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created command processor request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"401","description":"Command request create error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-runs/createtargetruncommand"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/"},{"label":"Update target run command information.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/2_target-runs/puttargetruncommandstatus","routeSlug":"/openapi/2_target-runs/puttargetruncommandstatus","metadata":{"seo":{"title":"Update target run command information.","description":"Update target run command information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putTargetRunCommandStatus","name":"Update target run command information.","isWebhook":false,"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1{command_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update target run command information.","badges":[{"name":"Stable","color":"green"}],"isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"SCAPIAuthToken","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"stage_run_id","in":"path","schemaId":"schema_300","description":"ID of the stage run","required":true},{"name":"target_run_id","in":"path","schemaId":"schema_300","description":"Id of the target run","required":true},{"name":"command_id","in":"path","schemaId":"schema_300","description":"Id of the command","required":true}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1{command_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommandRequest_PUT"}},"schemaId":"components/schemas/CommandRequest_PUT","pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1{command_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/{command_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"stage_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"target_run_id","in":"path","required":true,"schemaId":"schema_300"},{"name":"command_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommandRequest_PUT"}},"responseCodes":["200","400"],"pointer":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/{command_id}/","href":"2_target-runs/puttargetruncommandstatus","openApiOperationId":"putTargetRunCommandStatus","summary":"Update target run command information."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/CommandRequest_PUT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommandRequest_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Command processor request status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454"},{"code":"400","description":"Target run command update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"}],"pointer":"/paths/~1pipelines~1v0~1stageruns~1{stage_run_id}~1targetruns~1{target_run_id}~1command~1{command_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/2_target-runs/puttargetruncommandstatus"}],"panels":[]}]},"badges":[{"name":"Stable","color":"green"}],"httpPath":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/{command_id}/"}],"content":{"contentType":"group","meta":{"name":"2_Target Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Target Runs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to manage Target Runs. Target run status descriptions"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDING - Target run created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"QUEUED - Target run queued for processing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PROCESSING - Target run received by scheduler for processing (During target run processing the command request for the target run is created)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DISPATCHED - Target run moves to dispatched when a command is successfully queued for the target run. (Command status - QUEUED)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RUNNING - Target run moves to running state when the command has been sent to the device (Command status - INITIATED, ACKNOWLEDGED, INPROGRESS)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMPLETE - Target run moves to complete state when it has completed running (Command status - FAILURE, SUCCESS, TIMEOUT, CANCELLED)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUCCESS - A completed target run moves to success when the associated command is successful (Command status - SUCCESS)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILURE - A completed target run moves to success when the associated command is unsuccessful (Command status - FAILED, TIMEOUT, CANCELLED)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED - Target run cancelled by the user (Target runs ind Pending, Queued and Processing state can be cancelled by the user)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TIMEOUT -  The target run has a timed out. This happens when the target run has not completed processing even after the timeout period (7 days)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID - Target run is invalid."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/","summary":"Get all Target Runs for the Stage Run","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-runs/getpipelinestagetargetruns","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/","summary":"Create a Target Runs for Stage Run","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-runs/createpipelinestagetargetruns","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/","summary":"Get Target Run by Target Run ID","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-runs/getpipelinestagetargetrun","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/","summary":"Update a Target Run","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-runs/updatepipelinestagetargetrun","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/","summary":"Get status of the command running for Target run","prefix":{"name":"get","color":"get"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-runs/gettargetruncommandstatus","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/","summary":"Create an command processor request for Target Run","prefix":{"name":"post","color":"post"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-runs/createtargetruncommand","deprecated":false},{"title":"/pipelines/v0/stageruns/{stage_run_id}/targetruns/{target_run_id}/command/{command_id}/","summary":"Update target run command information.","prefix":{"name":"put","color":"put"},"badges":[{"name":"Stable","color":"green"}],"link":"/2_target-runs/puttargetruncommandstatus","deprecated":false}]}]}]}]}},{"type":"separator","label":"DEVICE","content":null},{"type":"group","label":"Device","link":"/openapi/3_device","routeSlug":"/openapi/3_device","items":[{"label":"Get all devices in the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device/getdevicelist","routeSlug":"/openapi/3_device/getdevicelist","metadata":{"seo":{"title":"Get all devices in the tenant","description":"Returns all the devices in the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceList","name":"Get all devices in the tenant","isWebhook":false,"pointer":"/paths/~1device~1v0~1devices~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all devices in the tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the devices in the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"ordering","in":"query","schemaId":"schema_455","description":"Field to order the results by. Prefix with '-' to reverse the order."},{"name":"serial","in":"query","schemaId":"schema_300"},{"name":"udid","in":"query","schemaId":"schema_300"},{"name":"android_version","in":"query","schemaId":"schema_300"},{"name":"ios_version","in":"query","schemaId":"schema_300"},{"name":"ipados_version","in":"query","schemaId":"schema_300"},{"name":"tvos_version","in":"query","schemaId":"schema_300"},{"name":"windows_version","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"schema_302"},{"name":"battery_level_gte","in":"query","schemaId":"schema_300"},{"name":"battery_level_lte","in":"query","schemaId":"schema_300"},{"name":"is_gms","in":"query","schemaId":"schema_301"},{"name":"active_connection","in":"query","schemaId":"schema_300"},{"name":"group_multi","in":"query","schemaId":"schema_299","description":"Filter by multiple group ID. Fetch the devices from groups matching with the IDs and its subgroup."},{"name":"group_multi_immediate","in":"query","schemaId":"schema_299","description":"Filter by multiple group IDs. Fetch the devices from groups matching with the IDs. Excludes devices in any subgroups."},{"name":"assigned_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id_net","in":"query","schemaId":"schema_299"},{"name":"platform","in":"query","schemaId":"schema_456"},{"name":"os","in":"query","schemaId":"schema_457"},{"name":"device_source","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a csv list of device sources [ABM, NON_ABM]"},"children":[]}]}]}]},{"name":"tags","in":"query","schemaId":"schema_300","description":"a csv list of tag UUID's"},{"name":"search","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search devices by multiOS -> name, serial, imei, model. Apple -> udid. Android -> iccid, phone number, brand, wifi, manufacturer, hardware"},"children":[]}]}]}]},{"name":"foundation_device_model_id","in":"query","schemaId":"schema_299"},{"name":"android_version_exact","in":"query","schemaId":"schema_300"},{"name":"foundation_major_version","in":"query","schemaId":"schema_302"},{"name":"foundation_minor_version","in":"query","schemaId":"schema_302"},{"name":"foundation_build_number","in":"query","schemaId":"schema_302"},{"name":"airwave_tenant_model_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_number","in":"query","schemaId":"schema_302"},{"name":"is_seamless","in":"query","schemaId":"schema_301"},{"name":"global_device_id","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1device~1v0~1devices~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/device/v0/devices/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"ordering","in":"query","schemaId":"schema_455"},{"name":"serial","in":"query","schemaId":"schema_300"},{"name":"udid","in":"query","schemaId":"schema_300"},{"name":"android_version","in":"query","schemaId":"schema_300"},{"name":"ios_version","in":"query","schemaId":"schema_300"},{"name":"ipados_version","in":"query","schemaId":"schema_300"},{"name":"tvos_version","in":"query","schemaId":"schema_300"},{"name":"windows_version","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"schema_302"},{"name":"battery_level_gte","in":"query","schemaId":"schema_300"},{"name":"battery_level_lte","in":"query","schemaId":"schema_300"},{"name":"is_gms","in":"query","schemaId":"schema_301"},{"name":"active_connection","in":"query","schemaId":"schema_300"},{"name":"group_multi","in":"query","schemaId":"schema_299"},{"name":"group_multi_immediate","in":"query","schemaId":"schema_299"},{"name":"assigned_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id_net","in":"query","schemaId":"schema_299"},{"name":"platform","in":"query","schemaId":"schema_456"},{"name":"os","in":"query","schemaId":"schema_457"},{"name":"device_source","in":"query","schemaId":"schema_300"},{"name":"tags","in":"query","schemaId":"schema_300"},{"name":"search","in":"query","schemaId":"schema_300"},{"name":"foundation_device_model_id","in":"query","schemaId":"schema_299"},{"name":"android_version_exact","in":"query","schemaId":"schema_300"},{"name":"foundation_major_version","in":"query","schemaId":"schema_302"},{"name":"foundation_minor_version","in":"query","schemaId":"schema_302"},{"name":"foundation_build_number","in":"query","schemaId":"schema_302"},{"name":"airwave_tenant_model_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_number","in":"query","schemaId":"schema_302"},{"name":"is_seamless","in":"query","schemaId":"schema_301"},{"name":"global_device_id","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/device/v0/devices/","href":"3_device/getdevicelist","openApiOperationId":"getDeviceList","summary":"Get all devices in the tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Device information for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458"}},"schemaId":"schema_458"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1device~1v0~1devices~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_458","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device/getdevicelist"}],"panels":[]}]},"httpPath":"/device/v0/devices/"},{"label":"Get details of a Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device/getdevicerequest","routeSlug":"/openapi/3_device/getdevicerequest","metadata":{"seo":{"title":"Get details of a Device","description":"Get details of a Device"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceRequest","name":"Get details of a Device","isWebhook":false,"pointer":"/paths/~1device~1v0~1devices~1{id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details of a Device","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_299","description":"ID of the device","required":true}],"pointer":"/paths/~1device~1v0~1devices~1{id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/device/v0/devices/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/device/v0/devices/{id}/","href":"3_device/getdevicerequest","openApiOperationId":"getDeviceRequest","summary":"Get details of a Device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the device","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}},"schemaId":"schema_459"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1device~1v0~1devices~1{id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_459","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_459"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device/getdevicerequest"}],"panels":[]}]},"httpPath":"/device/v0/devices/{id}/"},{"label":"Delete a device. Currently supported by iOS, Linux and Windows devices.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device/deletedevicerequest","routeSlug":"/openapi/3_device/deletedevicerequest","metadata":{"seo":{"title":"Delete a device. Currently supported by iOS, Linux and Windows devices.","description":"Delete a device. Currently supported by iOS, Linux and Windows devices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDeviceRequest","name":"Delete a device. Currently supported by iOS, Linux and Windows devices.","isWebhook":false,"pointer":"/paths/~1device~1v0~1devices~1{id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a device. Currently supported by iOS, Linux and Windows devices.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the device","required":true}],"pointer":"/paths/~1device~1v0~1devices~1{id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/device/v0/devices/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/device/v0/devices/{id}/","href":"3_device/deletedevicerequest","openApiOperationId":"deleteDeviceRequest","summary":"Delete a device. Currently supported by iOS, Linux and Windows devices."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the device","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}},"schemaId":"schema_460"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Device not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1device~1v0~1devices~1{id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_460","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_460"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device/deletedevicerequest"}],"panels":[]}]},"httpPath":"/device/v0/devices/{id}/"},{"label":"Get details of Current Device State","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device/getdevicestaterequest","routeSlug":"/openapi/3_device/getdevicestaterequest","metadata":{"seo":{"title":"Get details of Current Device State","description":"Get details of Current Device State"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceStateRequest","name":"Get details of Current Device State","isWebhook":false,"pointer":"/paths/~1device~1v0~1devices~1{id}~1devicestate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get details of Current Device State","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_299","description":"ID of the device","required":true}],"pointer":"/paths/~1device~1v0~1devices~1{id}~1devicestate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/device/v0/devices/{id}/devicestate","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/device/v0/devices/{id}/devicestate","href":"3_device/getdevicestaterequest","openApiOperationId":"getDeviceStateRequest","summary":"Get details of Current Device State"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Details of the current device state","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceSettings"}},"schemaId":"components/schemas/DeviceSettings"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1device~1v0~1devices~1{id}~1devicestate/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeviceSettings","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeviceSettings"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device/getdevicestaterequest"}],"panels":[]}]},"httpPath":"/device/v0/devices/{id}/devicestate"},{"label":"Get all distinct foundation versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device/getfoundationversionslist","routeSlug":"/openapi/3_device/getfoundationversionslist","metadata":{"seo":{"title":"Get all distinct foundation versions","description":"Returns a list of distinct foundation versions present in the tenant's devices"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFoundationVersionsList","name":"Get all distinct foundation versions","isWebhook":false,"pointer":"/paths/~1v2~1foundationversions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all distinct foundation versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of distinct foundation versions present in the tenant's devices"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_461","description":"Number of results to return per page"},{"name":"offset","in":"query","schemaId":"schema_306","description":"The initial index from which to return the results"},{"name":"search","in":"query","schemaId":"schema_300","description":"Filter foundation versions by partial string match (case-insensitive)"}],"pointer":"/paths/~1v2~1foundationversions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/foundationversions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_461"},{"name":"offset","in":"query","schemaId":"schema_306"},{"name":"search","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","500"],"pointer":"/v2/foundationversions","href":"3_device/getfoundationversionslist","openApiOperationId":"getFoundationVersionsList","summary":"Get all distinct foundation versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_462"}},"schemaId":"schema_462"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1foundationversions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_462","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_462"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device/getfoundationversionslist"}],"panels":[]}]},"httpPath":"/v2/foundationversions"}],"content":{"contentType":"group","meta":{"name":"3_Device"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device","showPageActions":true},{"nodeType":"markdoc","content":"APIs to retrieve information about the device or delete the device."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/device/v0/devices/","summary":"Get all devices in the tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device/getdevicelist","deprecated":false},{"title":"/device/v0/devices/{id}/","summary":"Get details of a Device","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device/getdevicerequest","deprecated":false},{"title":"/device/v0/devices/{id}/","summary":"Delete a device. Currently supported by iOS, Linux and Windows devices.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/3_device/deletedevicerequest","deprecated":false},{"title":"/device/v0/devices/{id}/devicestate","summary":"Get details of Current Device State","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device/getdevicestaterequest","deprecated":false},{"title":"/v2/foundationversions","summary":"Get all distinct foundation versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device/getfoundationversionslist","deprecated":false}]}]}]}]}},{"type":"group","label":"Device Heartbeat","link":"/openapi/3_device-heartbeat","routeSlug":"/openapi/3_device-heartbeat","items":[{"label":"Get heartbeat of a device which contains last seen information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-heartbeat/getdeviceheartbeat","routeSlug":"/openapi/3_device-heartbeat/getdeviceheartbeat","metadata":{"seo":{"title":"Get heartbeat of a device which contains last seen information","description":"Get heartbeat of a device which contains last seen information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceHeartbeat","name":"Get heartbeat of a device which contains last seen information","isWebhook":false,"pointer":"/paths/~1device~1v0~1heartbeat~1{id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get heartbeat of a device which contains last seen information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_299","description":"ID of the device","required":true}],"pointer":"/paths/~1device~1v0~1heartbeat~1{id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/device/v0/heartbeat/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/device/v0/heartbeat/{id}/","href":"3_device-heartbeat/getdeviceheartbeat","openApiOperationId":"getDeviceHeartbeat","summary":"Get heartbeat of a device which contains last seen information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Last seen details of the device","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_463"}},"schemaId":"schema_463"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1device~1v0~1heartbeat~1{id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_463","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_463"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-heartbeat/getdeviceheartbeat"}],"panels":[]}]},"httpPath":"/device/v0/heartbeat/{id}/"},{"label":"Get list of heartbeat for all devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-heartbeat/getdeviceheartbeatlist","routeSlug":"/openapi/3_device-heartbeat/getdeviceheartbeatlist","metadata":{"seo":{"title":"Get list of heartbeat for all devices","description":"Get list of heartbeat for all devices"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceHeartbeatList","name":"Get list of heartbeat for all devices","isWebhook":false,"pointer":"/paths/~1v2~1heartbeat~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of heartbeat for all devices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"last_seen_gt","in":"query","schemaId":"schema_464","description":"Specify the starting date and time for device lookup in the format (2023-08-29T00:00:00Z).","required":true},{"name":"last_seen_lt","in":"query","schemaId":"schema_465","description":"Specify the end date and time for device lookup in the format (2023-08-30T00:00:00Z).","required":true},{"name":"platform","in":"query","schemaId":"schema_456","description":"platform of the device"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"pointer":"/paths/~1v2~1heartbeat~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/heartbeat/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"last_seen_gt","in":"query","required":true,"example":"2023-08-29T00:00:00Z","schemaId":"schema_464"},{"name":"last_seen_lt","in":"query","required":true,"example":"2023-08-30T00:00:00Z","schemaId":"schema_465"},{"name":"platform","in":"query","schemaId":"schema_456"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/heartbeat/","href":"3_device-heartbeat/getdeviceheartbeatlist","openApiOperationId":"getDeviceHeartbeatList","summary":"Get list of heartbeat for all devices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Last seen details of the device","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}},"schemaId":"schema_466"},{"code":"400","description":"Device create error - Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1heartbeat~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_466","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_466"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-heartbeat/getdeviceheartbeatlist"}],"panels":[]}]},"httpPath":"/v2/heartbeat/"}],"content":{"contentType":"group","meta":{"name":"3_Device Heartbeat"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Heartbeat","showPageActions":true},{"nodeType":"markdoc","content":"APIs to retrieve information about device's heartbeat which contains the last seen details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/device/v0/heartbeat/{id}/","summary":"Get heartbeat of a device which contains last seen information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-heartbeat/getdeviceheartbeat","deprecated":false},{"title":"/v2/heartbeat/","summary":"Get list of heartbeat for all devices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-heartbeat/getdeviceheartbeatlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Device Apps","link":"/openapi/3_device-apps","routeSlug":"/openapi/3_device-apps","items":[{"label":"Get all apps for a device in the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-apps/paths/~1v2~1devices~1{deviceid}~1device-apps~1/get","routeSlug":"/openapi/3_device-apps/paths/~1v2~1devices~1{deviceid}~1device-apps~1/get","metadata":{"seo":{"title":"Get all apps for a device in the tenant","description":"Returns all the apps for a device"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get all apps for a device in the tenant","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1device-apps~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all apps for a device in the tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the apps for a device"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_300","description":"ID of the device","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1device-apps~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"app type","in":"query","schemaId":"schema_467","description":"App Type to filter list by, supports multiple values separated by comma"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1device-apps~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/devices/{deviceId}/device-apps/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"app type","in":"query","schemaId":"schema_467"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/devices/{deviceId}/device-apps/","href":"3_device-apps/paths/~1v2~1devices~1{deviceid}~1device-apps~1/get","summary":"Get all apps for a device in the tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}},"schemaId":"schema_468"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1device-apps~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_468","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_468"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-apps/paths/~1v2~1devices~1{deviceid}~1device-apps~1/get"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/device-apps/"},{"label":"Get list of devices with an app by app_id or app_version_id.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-apps/paths/~1v2~1device-apps/get","routeSlug":"/openapi/3_device-apps/paths/~1v2~1device-apps/get","metadata":{"seo":{"title":"Get list of devices with an app by app_id or app_version_id.","description":"Get list of devices with an app by app_id or app_version_id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get list of devices with an app by app_id or app_version_id.","isWebhook":false,"pointer":"/paths/~1v2~1device-apps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list of devices with an app by app_id or app_version_id.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"app_id","in":"query","schemaId":"schema_469","required":true},{"name":"app_version_id","in":"query","schemaId":"schema_469","required":true}],"pointer":"/paths/~1v2~1device-apps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/device-apps","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"app_id","in":"query","required":true,"schemaId":"schema_469"},{"name":"app_version_id","in":"query","required":true,"schemaId":"schema_469"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/device-apps","href":"3_device-apps/paths/~1v2~1device-apps/get","summary":"Get list of devices with an app by app_id or app_version_id."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}},"schemaId":"schema_470"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1device-apps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_470","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_470"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-apps/paths/~1v2~1device-apps/get"}],"panels":[]}]},"httpPath":"/v2/device-apps"}],"content":{"contentType":"group","meta":{"name":"3_Device Apps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Apps","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to get apps installed on iOS devices. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api.esper.io/tag/Application/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get apps for Android devices."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/devices/{deviceId}/device-apps/","summary":"Get all apps for a device in the tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-apps/paths/~1v2~1devices~1{deviceid}~1device-apps~1/get","deprecated":false},{"title":"/v2/device-apps","summary":"Get list of devices with an app by app_id or app_version_id.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-apps/paths/~1v2~1device-apps/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Device Enrollment in EMM","link":"/openapi/3_device-enrollment-in-emm","routeSlug":"/openapi/3_device-enrollment-in-emm","items":[{"label":"Get the Google EMM Policy details for a specific device.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/get","routeSlug":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/get","metadata":{"seo":{"title":"Get the Google EMM Policy details for a specific device.","description":"Get the Google EMM Policy details for a specific device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get the Google EMM Policy details for a specific device.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the Google EMM Policy details for a specific device.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"ID of the device for which to retrieve the Google EMM policy","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/devices/{deviceId}/google-accounts/policy/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/devices/{deviceId}/google-accounts/policy/","href":"3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/get","summary":"Get the Google EMM Policy details for a specific device."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEMMDevice"}},"schemaId":"components/schemas/GoogleEMMDevice"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleEMMDevice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEMMDevice"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/get"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/google-accounts/policy/"},{"label":"Update the Google EMM Policy details for a specific device.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/put","routeSlug":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/put","metadata":{"seo":{"title":"Update the Google EMM Policy details for a specific device.","description":"Update the Google EMM Policy details for a specific device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update the Google EMM Policy details for a specific device.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the Google EMM Policy details for a specific device.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"The unique identifier of the device for which Google account details need to be updated.","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"is_provisioning","in":"query","schemaId":"schema_471","description":"Flag indicating if provisioning is enabled (true or false). Default is false."},{"name":"is_converging","in":"query","schemaId":"schema_471","description":"Flag indicating if convergence is enabled (true or false). Default is false."}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleEMMDevicePolicyRequest"}},"schemaId":"components/schemas/GoogleEMMDevicePolicyRequest","pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/devices/{deviceId}/google-accounts/policy/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"is_provisioning","in":"query","required":false,"schemaId":"schema_471"},{"name":"is_converging","in":"query","required":false,"schemaId":"schema_471"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleEMMDevicePolicyRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v2/devices/{deviceId}/google-accounts/policy/","href":"3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/put","summary":"Update the Google EMM Policy details for a specific device."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleEMMDevicePolicyRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleEMMDevicePolicyRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the Google EMM policy details for the specified device.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}},"schemaId":"schema_472"},{"code":"400","description":"Bad request due to invalid input.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Device not found for the provided deviceId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error occurred while processing the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1policy~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_472","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_472"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/put"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/google-accounts/policy/"},{"label":"Get the List of Google EMM Managed Devices for a user's devices.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1emm-managed~1/get","routeSlug":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1emm-managed~1/get","metadata":{"seo":{"title":"Get the List of Google EMM Managed Devices for a user's devices.","description":"Get the List of Google EMM Managed Devices for a user's devices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get the List of Google EMM Managed Devices for a user's devices.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1emm-managed~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the List of Google EMM Managed Devices for a user's devices.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"ID of the device for which to retrieve the Google EMM policy","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1emm-managed~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/devices/{deviceId}/google-accounts/emm-managed/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/devices/{deviceId}/google-accounts/emm-managed/","href":"3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1emm-managed~1/get","summary":"Get the List of Google EMM Managed Devices for a user's devices."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DevicesListResponse"}},"schemaId":"components/schemas/DevicesListResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1emm-managed~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DevicesListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DevicesListResponse"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1emm-managed~1/get"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/google-accounts/emm-managed/"},{"label":"Return the Google account details of the EMM enrollment stored in the database for the specified device.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/get","routeSlug":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/get","metadata":{"seo":{"title":"Return the Google account details of the EMM enrollment stored in the database for the specified device.","description":"Return the Google account details of the EMM enrollment stored in the database for the specified device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Return the Google account details of the EMM enrollment stored in the database for the specified device.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return the Google account details of the EMM enrollment stored in the database for the specified device.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"ID of the device for which to retrieve the EMM enrollment status","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/devices/{deviceId}/google-accounts/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","500"],"pointer":"/v2/devices/{deviceId}/google-accounts/","href":"3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/get","summary":"Return the Google account details of the EMM enrollment stored in the database for the specified device."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_473"}},"schemaId":"schema_473"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_473","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_473"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/get"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/google-accounts/"},{"label":"Update the Google account details of the EMM enrollment stored in the database for a specific device.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/put","routeSlug":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/put","metadata":{"seo":{"title":"Update the Google account details of the EMM enrollment stored in the database for a specific device.","description":"Update the Google account details of the EMM enrollment stored in the database for a specific device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update the Google account details of the EMM enrollment stored in the database for a specific device.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the Google account details of the EMM enrollment stored in the database for a specific device.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"The unique identifier of the device for which Google account details need to be updated.","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleAccountUpdateRequestBody"}},"schemaId":"components/schemas/GoogleAccountUpdateRequestBody","pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/devices/{deviceId}/google-accounts/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleAccountUpdateRequestBody"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v2/devices/{deviceId}/google-accounts/","href":"3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/put","summary":"Update the Google account details of the EMM enrollment stored in the database for a specific device."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleAccountUpdateRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleAccountUpdateRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the Google account details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}},"schemaId":"schema_474"},{"code":"400","description":"Bad request due to invalid input.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Device not found for the provided deviceId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error occurred while processing the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_474","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_474"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/put"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/google-accounts/"},{"label":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/post","routeSlug":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/post","metadata":{"seo":{"title":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side.","description":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"The unique identifier of the device for which Google account details need to be updated.","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleAccount"}},"schemaId":"components/schemas/GoogleAccount","pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/devices/{deviceId}/google-accounts/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleAccount"}},"responseCodes":["200","401","404","409","500"],"pointer":"/v2/devices/{deviceId}/google-accounts/","href":"3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/post","summary":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully updated the Google account details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475"}},"schemaId":"schema_475"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Device not found for the provided deviceId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}},"schemaId":"components/schemas/Error_409_Conflict"},{"code":"500","description":"Internal server error occurred while processing the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_475","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"409","schemaId":"components/schemas/Error_409_Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/post"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/google-accounts/"},{"label":"Unenrolls device from Google EMM and deletes the Google account details.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/delete","routeSlug":"/openapi/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/delete","metadata":{"seo":{"title":"Unenrolls device from Google EMM and deletes the Google account details.","description":"Unenrolls device from Google EMM and deletes the Google account details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Unenrolls device from Google EMM and deletes the Google account details.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unenrolls device from Google EMM and deletes the Google account details.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"The unique identifier of the device for which Google account details need to be updated.","required":true}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/devices/{deviceId}/google-accounts/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","404","500"],"pointer":"/v2/devices/{deviceId}/google-accounts/","href":"3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/delete","summary":"Unenrolls device from Google EMM and deletes the Google account details."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully unenrolled and deleted the Google account details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475"}},"schemaId":"schema_475"},{"code":"401","description":"Unauthorized access.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Device not found for the provided deviceId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error occurred while processing the request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{deviceId}~1google-accounts~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_475","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_475"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/delete"}],"panels":[]}]},"httpPath":"/v2/devices/{deviceId}/google-accounts/"}],"content":{"contentType":"group","meta":{"name":"3_Device Enrollment in EMM"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device Enrollment in EMM","showPageActions":true},{"nodeType":"markdoc","content":"APIs to enroll device with Google EMM"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/devices/{deviceId}/google-accounts/policy/","summary":"Get the Google EMM Policy details for a specific device.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/get","deprecated":false},{"title":"/v2/devices/{deviceId}/google-accounts/policy/","summary":"Update the Google EMM Policy details for a specific device.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1policy~1/put","deprecated":false},{"title":"/v2/devices/{deviceId}/google-accounts/emm-managed/","summary":"Get the List of Google EMM Managed Devices for a user's devices.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1emm-managed~1/get","deprecated":false},{"title":"/v2/devices/{deviceId}/google-accounts/","summary":"Return the Google account details of the EMM enrollment stored in the database for the specified device.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/get","deprecated":false},{"title":"/v2/devices/{deviceId}/google-accounts/","summary":"Update the Google account details of the EMM enrollment stored in the database for a specific device.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/put","deprecated":false},{"title":"/v2/devices/{deviceId}/google-accounts/","summary":"Create a Google user and, if request body is not provided, generate a Google auth token for a specific device on the Google EMM side.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/post","deprecated":false},{"title":"/v2/devices/{deviceId}/google-accounts/","summary":"Unenrolls device from Google EMM and deletes the Google account details.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/3_device-enrollment-in-emm/paths/~1v2~1devices~1{deviceid}~1google-accounts~1/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Operations","link":"/openapi/3_operations","routeSlug":"/openapi/3_operations","items":[{"label":"Get all Operations in the Tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_operations/getoperationslist","routeSlug":"/openapi/3_operations/getoperationslist","metadata":{"seo":{"title":"Get all Operations in the Tenant","description":"Get all Operations in the Tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOperationsList","name":"Get all Operations in the Tenant","isWebhook":false,"pointer":"/paths/~1v0~1operations~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all Operations in the Tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"state","in":"query","schemaId":"schema_302","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following are the Operation States and their corresponding integer values"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"OPERATION_CREATED      = 10\nOPERATION_RESOLVING    = 20\nOPERATION_RESOLVED     = 30\nOPERATION_DISPATCHING  = 40\nOPERATION_DISPATCHED   = 50\nOPERATION_PROCESSING   = 60\nOPERATION_COMPLETED    = 70\nOPERATION_SUCCESS      = 80\nOPERATION_FAILURE      = 90\nOPERATION_SCHEDULED    = 100\nOPERATION_CANCELLED    = 110\nOPERATION_TIMEOUT      = 120\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OPERATION_CREATED      = 10\nOPERATION_RESOLVING    = 20\nOPERATION_RESOLVED     = 30\nOPERATION_DISPATCHING  = 40\nOPERATION_DISPATCHED   = 50\nOPERATION_PROCESSING   = 60\nOPERATION_COMPLETED    = 70\nOPERATION_SUCCESS      = 80\nOPERATION_FAILURE      = 90\nOPERATION_SCHEDULED    = 100\nOPERATION_CANCELLED    = 110\nOPERATION_TIMEOUT      = 120\n"},"children":[]}]}]},{"name":"ordering","in":"query","schemaId":"schema_476","description":"Field to order the results by. Prefix with '-' to reverse the order."},{"name":"operation_type","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter operations by type (e.g., INSTALL, UNINSTALL, CONVERGE, INSTALL_APP, UNINSTALL_APP, REBOOT)"},"children":[]}]}]}]},{"name":"group_multi","in":"query","schemaId":"schema_299","description":"Filter by multiple group ID. Fetch the devices from groups matching with the IDs and its subgroup."}],"pointer":"/paths/~1v0~1operations~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/operations/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"state","in":"query","schemaId":"schema_302"},{"name":"ordering","in":"query","schemaId":"schema_476"},{"name":"operation_type","in":"query","schemaId":"schema_300"},{"name":"group_multi","in":"query","schemaId":"schema_299"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v0/operations/","href":"3_operations/getoperationslist","openApiOperationId":"getOperationsList","summary":"Get all Operations in the Tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operations information for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_477"}},"schemaId":"schema_477"}],"pointer":"/paths/~1v0~1operations~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_477","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_477"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_operations/getoperationslist"}],"panels":[]}]},"httpPath":"/v0/operations/"},{"label":"Create a new Operation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_operations/createoperation","routeSlug":"/openapi/3_operations/createoperation","metadata":{"seo":{"title":"Create a new Operation","description":"Create a new Operation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOperation","name":"Create a new Operation","isWebhook":false,"pointer":"/paths/~1v0~1operations~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new Operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Operations_POST","exampleIds":["paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/devices","paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/filters"]}},"schemaId":"components/schemas/Operations_POST","exampleIds":["paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/devices","paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/filters"],"pointer":"/paths/~1v0~1operations~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v0/operations/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Operations_POST","exampleIds":["paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/devices","paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/filters"]}},"responseCodes":["201"],"pointer":"/v0/operations/","href":"3_operations/createoperation","openApiOperationId":"createOperation","summary":"Create a new Operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Operations_POST","exampleIds":["paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/devices","paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/filters"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Operations_POST","exampleIds":["paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/devices","paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/filters"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Operation information for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478"}],"pointer":"/paths/~1v0~1operations~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_operations/createoperation"}],"panels":[]}]},"httpPath":"/v0/operations/"},{"label":"Get specific Operation details (Operation Status)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_operations/getoperation","routeSlug":"/openapi/3_operations/getoperation","metadata":{"seo":{"title":"Get specific Operation details (Operation Status)","description":"Get specific Operation details (Operation Status)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOperation","name":"Get specific Operation details (Operation Status)","isWebhook":false,"pointer":"/paths/~1v0~1operations~1{operationId}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specific Operation details (Operation Status)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationId","in":"path","schemaId":"schema_299","description":"ID of the Operation","required":true}],"pointer":"/paths/~1v0~1operations~1{operationId}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/operations/{operationId}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v0/operations/{operationId}/","href":"3_operations/getoperation","openApiOperationId":"getOperation","summary":"Get specific Operation details (Operation Status)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operation information for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}},"schemaId":"schema_478"}],"pointer":"/paths/~1v0~1operations~1{operationId}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_478","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_478"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_operations/getoperation"}],"panels":[]}]},"httpPath":"/v0/operations/{operationId}/"},{"label":"Update the operation (Support status update as of now)","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_operations/paths/~1v0~1operations~1{operationid}~1/put","routeSlug":"/openapi/3_operations/paths/~1v0~1operations~1{operationid}~1/put","metadata":{"seo":{"title":"Update the operation (Support status update as of now)","description":"This API allows updating the status of a specific operation by providing the operation ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update the operation (Support status update as of now)","isWebhook":false,"pointer":"/paths/~1v0~1operations~1{operationId}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the operation (Support status update as of now)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API allows updating the status of a specific operation by providing the operation ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationId","in":"path","schemaId":"schema_479","description":"The ID of the operation to update (Put created operationId here)","required":true}],"pointer":"/paths/~1v0~1operations~1{operationId}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_480","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/requestBody/content/application~1json/examples/example-1"]}},"schemaId":"schema_480","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/requestBody/content/application~1json/examples/example-1"],"pointer":"/paths/~1v0~1operations~1{operationId}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v0/operations/{operationId}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationId","in":"path","required":true,"example":"5743470f-7dcc-4a92-8a4b-f41b1cea69ed","schemaId":"schema_479"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_480","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/requestBody/content/application~1json/examples/example-1"]}},"responseCodes":["200"],"pointer":"/v0/operations/{operationId}/","href":"3_operations/paths/~1v0~1operations~1{operationid}~1/put","summary":"Update the operation (Support status update as of now)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_480","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/requestBody/content/application~1json/examples/example-1"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_480","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/requestBody/content/application~1json/examples/example-1"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operation status updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_481","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_481","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v0~1operations~1{operationId}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_481","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_481","exampleIds":["paths/~1v0~1operations~1{operationId}~1/put/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_operations/paths/~1v0~1operations~1{operationid}~1/put"}],"panels":[]}]},"httpPath":"/v0/operations/{operationId}/"}],"content":{"contentType":"group","meta":{"name":"3_Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operations","showPageActions":true},{"nodeType":"markdoc","content":"APIs to get information about operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/operations/","summary":"Get all Operations in the Tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_operations/getoperationslist","deprecated":false},{"title":"/v0/operations/","summary":"Create a new Operation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/3_operations/createoperation","deprecated":false},{"title":"/v0/operations/{operationId}/","summary":"Get specific Operation details (Operation Status)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_operations/getoperation","deprecated":false},{"title":"/v0/operations/{operationId}/","summary":"Update the operation (Support status update as of now)","prefix":{"name":"put","color":"put"},"badges":[],"link":"/3_operations/paths/~1v0~1operations~1{operationid}~1/put","deprecated":false}]}]}]}]}},{"type":"group","label":"DeviceOperations","link":"/openapi/3_deviceoperations","routeSlug":"/openapi/3_deviceoperations","items":[{"label":"Get all DeviceOperations for a specific Operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_deviceoperations/getdeviceoperations","routeSlug":"/openapi/3_deviceoperations/getdeviceoperations","metadata":{"seo":{"title":"Get all DeviceOperations for a specific Operation","description":"Get all DeviceOperations for a specific Operation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceOperations","name":"Get all DeviceOperations for a specific Operation","isWebhook":false,"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all DeviceOperations for a specific Operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationsId","in":"path","schemaId":"schema_299","description":"ID of the Operation","required":true,"example":"5743470f-7dcc-4a92-8a4b-f41b1cea69ed"}],"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"state","in":"query","schemaId":"schema_302","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following are the Device Operation States and their corresponding integer values"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"DEVICE_OPERATION_CREATED     = 10\nDEVICE_OPERATION_INITIATED   = 20\nDEVICE_OPERATION_DISPATCHED  = 30\nDEVICE_OPERATION_PROCESSING  = 40\nDEVICE_OPERATION_SUCCESS     = 50\nDEVICE_OPERATION_FAILURE     = 60\nDEVICE_OPERATION_CANCELLED   = 70\nDEVICE_OPERATION_TIMEOUT     = 80\nDEVICE_OPERATION_COMPLETED   = 90\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"DEVICE_OPERATION_CREATED     = 10\nDEVICE_OPERATION_INITIATED   = 20\nDEVICE_OPERATION_DISPATCHED  = 30\nDEVICE_OPERATION_PROCESSING  = 40\nDEVICE_OPERATION_SUCCESS     = 50\nDEVICE_OPERATION_FAILURE     = 60\nDEVICE_OPERATION_CANCELLED   = 70\nDEVICE_OPERATION_TIMEOUT     = 80\nDEVICE_OPERATION_COMPLETED   = 90\n"},"children":[]}]}]},{"name":"ordering","in":"query","schemaId":"schema_476","description":"Field to order the results by. Prefix with '-' to reverse the order."}],"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/operations/{operationsId}/devices/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationsId","in":"path","required":true,"example":"5743470f-7dcc-4a92-8a4b-f41b1cea69ed","schemaId":"schema_299"}],"query":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"state","in":"query","schemaId":"schema_302"},{"name":"ordering","in":"query","schemaId":"schema_476"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v0/operations/{operationsId}/devices/","href":"3_deviceoperations/getdeviceoperations","openApiOperationId":"getDeviceOperations","summary":"Get all DeviceOperations for a specific Operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Device Operation information for the Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}},"schemaId":"schema_482"}],"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_482","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_482"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_deviceoperations/getdeviceoperations"}],"panels":[]}]},"httpPath":"/v0/operations/{operationsId}/devices/"},{"label":"Get a Operations for a device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_deviceoperations/paths/~1v0~1devices~1{deviceid}~1operations~1/get","routeSlug":"/openapi/3_deviceoperations/paths/~1v0~1devices~1{deviceid}~1operations~1/get","metadata":{"seo":{"title":"Get a Operations for a device","description":"Get a Operations for a device"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get a Operations for a device","isWebhook":false,"pointer":"/paths/~1v0~1devices~1{deviceId}~1operations~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Operations for a device","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"deviceId","in":"path","schemaId":"schema_299","description":"ID of the Device","required":true,"example":"17d384d3-29bd-4dd4-af64-d02b9d6d54ee"}],"pointer":"/paths/~1v0~1devices~1{deviceId}~1operations~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/devices/{deviceId}/operations/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"deviceId","in":"path","required":true,"example":"17d384d3-29bd-4dd4-af64-d02b9d6d54ee","schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v0/devices/{deviceId}/operations/","href":"3_deviceoperations/paths/~1v0~1devices~1{deviceid}~1operations~1/get","summary":"Get a Operations for a device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operations information for the Device","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_483"}},"schemaId":"schema_483"}],"pointer":"/paths/~1v0~1devices~1{deviceId}~1operations~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_483","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_483"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_deviceoperations/paths/~1v0~1devices~1{deviceid}~1operations~1/get"}],"panels":[]}]},"httpPath":"/v0/devices/{deviceId}/operations/"},{"label":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_deviceoperations/getdeviceoperation","routeSlug":"/openapi/3_deviceoperations/getdeviceoperation","metadata":{"seo":{"title":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)","description":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceOperation","name":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)","isWebhook":false,"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1{deviceId}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationsId","in":"path","schemaId":"schema_484","description":"ID of the Operation","required":true},{"name":"deviceId","in":"path","schemaId":"schema_485","description":"ID of the Device","required":true}],"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1{deviceId}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v0/operations/{operationsId}/devices/{deviceId}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationsId","in":"path","required":true,"example":"5743470f-7dcc-4a92-8a4b-f41b1cea69ed","schemaId":"schema_484"},{"name":"deviceId","in":"path","required":true,"example":"17d384d3-29bd-4dd4-af64-d02b9d6d54ee","schemaId":"schema_485"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v0/operations/{operationsId}/devices/{deviceId}/","href":"3_deviceoperations/getdeviceoperation","openApiOperationId":"getDeviceOperation","summary":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Device Operation information for the Operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_486"}},"schemaId":"schema_486"}],"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1{deviceId}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_486","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_486"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_deviceoperations/getdeviceoperation"}],"panels":[]}]},"httpPath":"/v0/operations/{operationsId}/devices/{deviceId}/"},{"label":"Update a specific DeviceOperation for a specific Operation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_deviceoperations/updatedeviceoperation","routeSlug":"/openapi/3_deviceoperations/updatedeviceoperation","metadata":{"seo":{"title":"Update a specific DeviceOperation for a specific Operation","description":"Update a specific DeviceOperation for a specific Operation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDeviceOperation","name":"Update a specific DeviceOperation for a specific Operation","isWebhook":false,"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1{deviceId}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a specific DeviceOperation for a specific Operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationsId","in":"path","schemaId":"schema_487","description":"ID of the Operation","required":true},{"name":"deviceId","in":"path","schemaId":"schema_488","description":"ID of the Device","required":true}],"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1{deviceId}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_489"}},"schemaId":"schema_489","pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1{deviceId}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v0/operations/{operationsId}/devices/{deviceId}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"operationsId","in":"path","required":true,"example":"0aae03d2-32b4-4cab-b733-6919b84bb2ac","schemaId":"schema_487"},{"name":"deviceId","in":"path","required":true,"example":"550e8400-e29b-41d4-a716-446655440000","schemaId":"schema_488"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_489"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v0/operations/{operationsId}/devices/{deviceId}/","href":"3_deviceoperations/updatedeviceoperation","openApiOperationId":"updateDeviceOperation","summary":"Update a specific DeviceOperation for a specific Operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_489","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_489"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Device Operation updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_486"}},"schemaId":"schema_486"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v0~1operations~1{operationsId}~1devices~1{deviceId}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_486","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_486"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_deviceoperations/updatedeviceoperation"}],"panels":[]}]},"httpPath":"/v0/operations/{operationsId}/devices/{deviceId}/"}],"content":{"contentType":"group","meta":{"name":"3_DeviceOperations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DeviceOperations","showPageActions":true},{"nodeType":"markdoc","content":"APIs to get information about device operations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v0/operations/{operationsId}/devices/","summary":"Get all DeviceOperations for a specific Operation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_deviceoperations/getdeviceoperations","deprecated":false},{"title":"/v0/devices/{deviceId}/operations/","summary":"Get a Operations for a device","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_deviceoperations/paths/~1v0~1devices~1{deviceid}~1operations~1/get","deprecated":false},{"title":"/v0/operations/{operationsId}/devices/{deviceId}/","summary":"Get a specific DeviceOperations for a specific Operation (Device Operation Status)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_deviceoperations/getdeviceoperation","deprecated":false},{"title":"/v0/operations/{operationsId}/devices/{deviceId}/","summary":"Update a specific DeviceOperation for a specific Operation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/3_deviceoperations/updatedeviceoperation","deprecated":false}]}]}]}]}},{"type":"group","label":"MultiOS Remote Viewer","link":"/openapi/3_multios-remote-viewer","routeSlug":"/openapi/3_multios-remote-viewer","items":[{"label":"Get RemoteViewer Activity Feed for the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_multios-remote-viewer/paths/~1v2~1rv-activity-feed~1/get","routeSlug":"/openapi/3_multios-remote-viewer/paths/~1v2~1rv-activity-feed~1/get","metadata":{"seo":{"title":"Get RemoteViewer Activity Feed for the tenant","description":"Get RemoteViewer Activity Feed for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get RemoteViewer Activity Feed for the tenant","isWebhook":false,"pointer":"/paths/~1v2~1rv-activity-feed~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get RemoteViewer Activity Feed for the tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"states","in":"query","schemaId":"schema_490"},{"name":"video_qualities","in":"query","schemaId":"schema_491"},{"name":"reason","in":"query","schemaId":"schema_492"},{"name":"created_by","in":"query","schemaId":"schema_493"},{"name":"device_name","in":"query","schemaId":"schema_494"},{"name":"ordering","in":"query","schemaId":"schema_495"},{"name":"duration_lt","in":"query","schemaId":"schema_496"},{"name":"duration_lte","in":"query","schemaId":"schema_497"},{"name":"duration_gt","in":"query","schemaId":"schema_498"},{"name":"duration_gte","in":"query","schemaId":"schema_499"},{"name":"created_at_lt","in":"query","schemaId":"schema_500"},{"name":"created_at_gt","in":"query","schemaId":"schema_501"},{"name":"created_at_lte","in":"query","schemaId":"schema_502"},{"name":"created_at_gte","in":"query","schemaId":"schema_503"},{"name":"updated_at_lt","in":"query","schemaId":"schema_504"},{"name":"updated_at_gt","in":"query","schemaId":"schema_505"},{"name":"updated_at_lte","in":"query","schemaId":"schema_506"},{"name":"updated_at_gte","in":"query","schemaId":"schema_507"}],"pointer":"/paths/~1v2~1rv-activity-feed~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/rv-activity-feed/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"states","in":"query","schemaId":"schema_490"},{"name":"video_qualities","in":"query","schemaId":"schema_491"},{"name":"reason","in":"query","schemaId":"schema_492"},{"name":"created_by","in":"query","schemaId":"schema_493"},{"name":"device_name","in":"query","schemaId":"schema_494"},{"name":"ordering","in":"query","schemaId":"schema_495"},{"name":"duration_lt","in":"query","example":"duration_lt=PT10M30S","schemaId":"schema_496"},{"name":"duration_lte","in":"query","example":"duration_lte=PT10M30S","schemaId":"schema_497"},{"name":"duration_gt","in":"query","example":"duration_gt=PT10M30S","schemaId":"schema_498"},{"name":"duration_gte","in":"query","example":"duration_gte=PT10M30S","schemaId":"schema_499"},{"name":"created_at_lt","in":"query","example":"created_at_lt=2023-10-01T12:00:00Z","schemaId":"schema_500"},{"name":"created_at_gt","in":"query","example":"created_at_gt=2023-10-01T12:00:00Z","schemaId":"schema_501"},{"name":"created_at_lte","in":"query","example":"created_at_lte=2023-10-01T12:00:00Z","schemaId":"schema_502"},{"name":"created_at_gte","in":"query","example":"created_at_gte=2023-10-01T12:00:00Z","schemaId":"schema_503"},{"name":"updated_at_lt","in":"query","example":"updated_at_lt=2023-10-01T12:00:00Z","schemaId":"schema_504"},{"name":"updated_at_gt","in":"query","example":"updated_at_gt=2023-10-01T12:00:00Z","schemaId":"schema_505"},{"name":"updated_at_lte","in":"query","example":"updated_at_lte=2023-10-01T12:00:00Z","schemaId":"schema_506"},{"name":"updated_at_gte","in":"query","example":"updated_at_gte=2023-10-01T12:00:00Z","schemaId":"schema_507"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","500"],"pointer":"/v2/rv-activity-feed/","href":"3_multios-remote-viewer/paths/~1v2~1rv-activity-feed~1/get","summary":"Get RemoteViewer Activity Feed for the tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}},"schemaId":"schema_508"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1rv-activity-feed~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_508","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_508"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_multios-remote-viewer/paths/~1v2~1rv-activity-feed~1/get"}],"panels":[]}]},"httpPath":"/v2/rv-activity-feed/"}],"content":{"contentType":"group","meta":{"name":"3_MultiOS Remote Viewer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"MultiOS Remote Viewer","showPageActions":true},{"nodeType":"markdoc","content":"API to get Remote Viewer activity for the tenant. Currently supports only Android devices with DPC 8.4 and above along with RemoteViewer 3.x."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/rv-activity-feed/","summary":"Get RemoteViewer Activity Feed for the tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_multios-remote-viewer/paths/~1v2~1rv-activity-feed~1/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Device V2","link":"/openapi/3_device-v2","routeSlug":"/openapi/3_device-v2","items":[{"label":"Get all devices in the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-v2/paths/~1v2~1devices~1/get","routeSlug":"/openapi/3_device-v2/paths/~1v2~1devices~1/get","metadata":{"seo":{"title":"Get all devices in the tenant","description":"Returns all the devices in the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get all devices in the tenant","isWebhook":false,"pointer":"/paths/~1v2~1devices~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all devices in the tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the devices in the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_509"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"cursor","in":"query","schemaId":"schema_510","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque cursor token for cursor-based pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to begin from the first page"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from previous response for subsequent pages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prev_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from previous response to navigate backward"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, offset parameter is ignored"},"children":[]}]}]}]}]},{"name":"ordering","in":"query","schemaId":"schema_511","description":"Field to order the results by. Prefix with '-' to reverse the order."},{"name":"serial","in":"query","schemaId":"schema_300"},{"name":"udid","in":"query","schemaId":"schema_300"},{"name":"android_version","in":"query","schemaId":"schema_300"},{"name":"ios_version","in":"query","schemaId":"schema_300"},{"name":"ipados_version","in":"query","schemaId":"schema_300"},{"name":"tvos_version","in":"query","schemaId":"schema_300"},{"name":"windows_version","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"schema_300"},{"name":"battery_level_gte","in":"query","schemaId":"schema_300"},{"name":"battery_level_lte","in":"query","schemaId":"schema_300"},{"name":"is_gms","in":"query","schemaId":"schema_301"},{"name":"active_connection","in":"query","schemaId":"schema_300"},{"name":"group_multi","in":"query","schemaId":"schema_299","description":"Filter by multiple group ID. Fetch the devices from groups matching with the IDs and its subgroup."},{"name":"group_multi_immediate","in":"query","schemaId":"schema_299","description":"Filter by multiple group IDs. Fetch the devices from groups matching with the IDs. Excludes devices in any subgroups."},{"name":"assigned_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id_net","in":"query","schemaId":"schema_299"},{"name":"platform","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a csv list of platforms [ANDROID, APPLE, LINUX, WINDOWS]"},"children":[]}]}]}]},{"name":"os","in":"query","schemaId":"schema_457"},{"name":"device_source","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a csv list of device sources [ABM, NON_ABM]"},"children":[]}]}]}]},{"name":"managed_by","in":"query","schemaId":"schema_512"},{"name":"template_multi","in":"query","schemaId":"schema_300","description":"a csv list of template names"},{"name":"policy_multi","in":"query","schemaId":"schema_300","description":"a csv list of policy names"},{"name":"search","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search devices by multiOS -> Name, Serial, IMEI, Model, WiFi SSID, Apple UDID, ICCID1, ICCID2, Brand, Manufacturer, Hardware, WiFi MAC Address, SIM Operator, Network Operator and IP Address."},"children":[]}]}]}]},{"name":"foundation_device_model_id","in":"query","schemaId":"schema_299"},{"name":"android_version_exact","in":"query","schemaId":"schema_300"},{"name":"foundation_major_version","in":"query","schemaId":"schema_302"},{"name":"foundation_minor_version","in":"query","schemaId":"schema_302"},{"name":"foundation_build_number","in":"query","schemaId":"schema_302"},{"name":"airwave_tenant_model_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_number","in":"query","schemaId":"schema_302"},{"name":"foundation_version","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full foundation version string (either os_version.major.minor.build or eea_version)"},"children":[]}]}]}]},{"name":"esper_agent_version_name","in":"query","schemaId":"schema_300","description":"Filter devices by Esper agent version name (DPC version)"},{"name":"tags","in":"query","schemaId":"schema_300","description":"a csv list of tag ids"},{"name":"is_locked_down","in":"query","schemaId":"schema_301"},{"name":"global_device_id","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1v2~1devices~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/devices/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_509"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"cursor","in":"query","example":"start","schemaId":"schema_510"},{"name":"ordering","in":"query","schemaId":"schema_511"},{"name":"serial","in":"query","schemaId":"schema_300"},{"name":"udid","in":"query","schemaId":"schema_300"},{"name":"android_version","in":"query","schemaId":"schema_300"},{"name":"ios_version","in":"query","schemaId":"schema_300"},{"name":"ipados_version","in":"query","schemaId":"schema_300"},{"name":"tvos_version","in":"query","schemaId":"schema_300"},{"name":"windows_version","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"schema_300"},{"name":"battery_level_gte","in":"query","schemaId":"schema_300"},{"name":"battery_level_lte","in":"query","schemaId":"schema_300"},{"name":"is_gms","in":"query","schemaId":"schema_301"},{"name":"active_connection","in":"query","schemaId":"schema_300"},{"name":"group_multi","in":"query","schemaId":"schema_299"},{"name":"group_multi_immediate","in":"query","schemaId":"schema_299"},{"name":"assigned_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id","in":"query","schemaId":"schema_299"},{"name":"current_blueprint_version_id_net","in":"query","schemaId":"schema_299"},{"name":"platform","in":"query","schemaId":"schema_300"},{"name":"os","in":"query","schemaId":"schema_457"},{"name":"device_source","in":"query","schemaId":"schema_300"},{"name":"managed_by","in":"query","schemaId":"schema_512"},{"name":"template_multi","in":"query","schemaId":"schema_300"},{"name":"policy_multi","in":"query","schemaId":"schema_300"},{"name":"search","in":"query","schemaId":"schema_300"},{"name":"foundation_device_model_id","in":"query","schemaId":"schema_299"},{"name":"android_version_exact","in":"query","schemaId":"schema_300"},{"name":"foundation_major_version","in":"query","schemaId":"schema_302"},{"name":"foundation_minor_version","in":"query","schemaId":"schema_302"},{"name":"foundation_build_number","in":"query","schemaId":"schema_302"},{"name":"airwave_tenant_model_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_id","in":"query","schemaId":"schema_300"},{"name":"airwave_build_number","in":"query","schemaId":"schema_302"},{"name":"foundation_version","in":"query","schemaId":"schema_300"},{"name":"esper_agent_version_name","in":"query","schemaId":"schema_300"},{"name":"tags","in":"query","schemaId":"schema_300"},{"name":"is_locked_down","in":"query","schemaId":"schema_301"},{"name":"global_device_id","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/devices/","href":"3_device-v2/paths/~1v2~1devices~1/get","summary":"Get all devices in the tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device information for the Tenant."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response format depends on pagination type used:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Offset-based"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prev"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URLs), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cursor-based"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next_cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"prev_cursor"},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_513"}},"schemaId":"schema_513"},{"code":"400","description":"Bad Request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_513","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_513"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-v2/paths/~1v2~1devices~1/get"}],"panels":[]}]},"httpPath":"/v2/devices/"},{"label":"Retrieve detailed device information.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/3_device-v2/paths/~1v2~1devices~1{id}/get","routeSlug":"/openapi/3_device-v2/paths/~1v2~1devices~1{id}/get","metadata":{"seo":{"title":"Retrieve detailed device information.","description":"Get device details for particular device id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve detailed device information.","isWebhook":false,"pointer":"/paths/~1v2~1devices~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed device information.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get device details for particular device id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_299","description":"ID of the device","required":true}],"pointer":"/paths/~1v2~1devices~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/devices/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/devices/{id}","href":"3_device-v2/paths/~1v2~1devices~1{id}/get","summary":"Retrieve detailed device information."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Detailed information of the device","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}},"schemaId":"schema_514"},{"code":"400","description":"Bad Request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Device not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1devices~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_514","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_514"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3_device-v2/paths/~1v2~1devices~1{id}/get"}],"panels":[]}]},"httpPath":"/v2/devices/{id}"}],"content":{"contentType":"group","meta":{"name":"3_Device V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Device V2","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/devices/","summary":"Get all devices in the tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-v2/paths/~1v2~1devices~1/get","deprecated":false},{"title":"/v2/devices/{id}","summary":"Retrieve detailed device information.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3_device-v2/paths/~1v2~1devices~1{id}/get","deprecated":false}]}]}]}]}},{"type":"separator","label":"APPS MANAGEMENT","content":null},{"type":"group","label":"VPP License Management","link":"/openapi/4_vpp-license-management","routeSlug":"/openapi/4_vpp-license-management","items":[{"label":"Get VPP License List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_vpp-license-management/paths/~1apps~1v0~1vpp/get","routeSlug":"/openapi/4_vpp-license-management/paths/~1apps~1v0~1vpp/get","metadata":{"seo":{"title":"Get VPP License List","description":"API to get a list of VPP licenses with the given VPP token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get VPP License List","isWebhook":false,"pointer":"/paths/~1apps~1v0~1vpp/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get VPP License List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get a list of VPP licenses with the given VPP token"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/apps/v0/vpp","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/apps/v0/vpp","href":"4_vpp-license-management/paths/~1apps~1v0~1vpp/get","summary":"Get VPP License List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}},"schemaId":"schema_515"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1apps~1v0~1vpp/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_515","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_515"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_vpp-license-management/paths/~1apps~1v0~1vpp/get"}],"panels":[]}]},"httpPath":"/apps/v0/vpp"},{"label":"Get VPP License Info about an App","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_vpp-license-management/paths/~1apps~1v0~1vpp~1{appid}/get","routeSlug":"/openapi/4_vpp-license-management/paths/~1apps~1v0~1vpp~1{appid}/get","metadata":{"seo":{"title":"Get VPP License Info about an App","description":"API to get information about the VPP license for a given app"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get VPP License Info about an App","isWebhook":false,"pointer":"/paths/~1apps~1v0~1vpp~1{appId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get VPP License Info about an App","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get information about the VPP license for a given app"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_302","required":true}],"pointer":"/paths/~1apps~1v0~1vpp~1{appId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/apps/v0/vpp/{appId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/apps/v0/vpp/{appId}","href":"4_vpp-license-management/paths/~1apps~1v0~1vpp~1{appid}/get","summary":"Get VPP License Info about an App"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_516"}},"schemaId":"schema_516"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1apps~1v0~1vpp~1{appId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_516","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_516"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_vpp-license-management/paths/~1apps~1v0~1vpp~1{appid}/get"}],"panels":[]}]},"httpPath":"/apps/v0/vpp/{appId}"}],"content":{"contentType":"group","meta":{"name":"4_VPP License Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VPP License Management","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs for managing VPP licenses for apps. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/20361103311761-Setting-Up-Apple-MDM-Management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VPP licenses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/apps/v0/vpp","summary":"Get VPP License List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_vpp-license-management/paths/~1apps~1v0~1vpp/get","deprecated":false},{"title":"/apps/v0/vpp/{appId}","summary":"Get VPP License Info about an App","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_vpp-license-management/paths/~1apps~1v0~1vpp~1{appid}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"VPP App Management","link":"/openapi/4_vpp-app-management","routeSlug":"/openapi/4_vpp-app-management","items":[{"label":"Get iOS App Info (v2)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_vpp-app-management/paths/~1v2~1itunesapps/get","routeSlug":"/openapi/4_vpp-app-management/paths/~1v2~1itunesapps/get","metadata":{"seo":{"title":"Get iOS App Info (v2)","description":"API to get information about iOS apps based on their app IDs or Apple app IDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get iOS App Info (v2)","isWebhook":false,"pointer":"/paths/~1v2~1itunesapps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get iOS App Info (v2)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get information about iOS apps based on their app IDs or Apple app IDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"app_id","in":"query","schemaId":"schema_299"},{"name":"version_id","in":"query","schemaId":"schema_299"},{"name":"apple_app_id","in":"query","schemaId":"schema_300"},{"name":"country_code","in":"query","schemaId":"schema_517","description":"ISO country code for App Store region (e.g., \"us\", \"gb\", \"de\"). Defaults to \"us\"."}],"pointer":"/paths/~1v2~1itunesapps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/itunesapps","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"app_id","in":"query","schemaId":"schema_299"},{"name":"version_id","in":"query","schemaId":"schema_299"},{"name":"apple_app_id","in":"query","schemaId":"schema_300"},{"name":"country_code","in":"query","example":"us","schemaId":"schema_517"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/itunesapps","href":"4_vpp-app-management/paths/~1v2~1itunesapps/get","summary":"Get iOS App Info (v2)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}},"schemaId":"schema_518"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1itunesapps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_518","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_518"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_vpp-app-management/paths/~1v2~1itunesapps/get"}],"panels":[]}]},"httpPath":"/v2/itunesapps"},{"label":"Set Preferred Region for VPP App","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_vpp-app-management/paths/~1v2~1itunesapps~1{appleappid}~1preferred-region/put","routeSlug":"/openapi/4_vpp-app-management/paths/~1v2~1itunesapps~1{appleappid}~1preferred-region/put","metadata":{"seo":{"title":"Set Preferred Region for VPP App","description":"API to set the preferred App Store region for a VPP app. This region is cached and used when fetching app info from iTunes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Set Preferred Region for VPP App","isWebhook":false,"pointer":"/paths/~1v2~1itunesapps~1{appleAppId}~1preferred-region/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Preferred Region for VPP App","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to set the preferred App Store region for a VPP app. This region is cached and used when fetching app info from iTunes."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appleAppId","in":"path","schemaId":"schema_300","description":"The Apple App Store ID of the VPP app (e.g., \"361309726\")","required":true}],"pointer":"/paths/~1v2~1itunesapps~1{appleAppId}~1preferred-region/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetPreferredRegionRequest"}},"schemaId":"components/schemas/SetPreferredRegionRequest","pointer":"/paths/~1v2~1itunesapps~1{appleAppId}~1preferred-region/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/itunesapps/{appleAppId}/preferred-region","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appleAppId","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SetPreferredRegionRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v2/itunesapps/{appleAppId}/preferred-region","href":"4_vpp-app-management/paths/~1v2~1itunesapps~1{appleappid}~1preferred-region/put","summary":"Set Preferred Region for VPP App"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/SetPreferredRegionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetPreferredRegionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}},"schemaId":"schema_519"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1itunesapps~1{appleAppId}~1preferred-region/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_519","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_519"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_vpp-app-management/paths/~1v2~1itunesapps~1{appleappid}~1preferred-region/put"}],"panels":[]}]},"httpPath":"/v2/itunesapps/{appleAppId}/preferred-region"}],"content":{"contentType":"group","meta":{"name":"4_VPP App Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VPP App Management","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs for getting information about VPP apps. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/20518326865681-Managing-iOS-Applications"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VPP apps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/itunesapps","summary":"Get iOS App Info (v2)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_vpp-app-management/paths/~1v2~1itunesapps/get","deprecated":false},{"title":"/v2/itunesapps/{appleAppId}/preferred-region","summary":"Set Preferred Region for VPP App","prefix":{"name":"put","color":"put"},"badges":[],"link":"/4_vpp-app-management/paths/~1v2~1itunesapps~1{appleappid}~1preferred-region/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Tenant Apps","link":"/openapi/4_tenant-apps","routeSlug":"/openapi/4_tenant-apps","items":[{"label":"Upload tenant app for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps/post","routeSlug":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps/post","metadata":{"seo":{"title":"Upload tenant app for a tenant","description":"Upload tenant app for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload tenant app for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1tenant-apps/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload tenant app for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/AppUploadRequestBody"}},"schemaId":"components/schemas/AppUploadRequestBody","pointer":"/paths/~1v2~1tenant-apps/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/tenant-apps","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/AppUploadRequestBody"}},"responseCodes":["200","400","401","403","500"],"pointer":"/v2/tenant-apps","href":"4_tenant-apps/paths/~1v2~1tenant-apps/post","summary":"Upload tenant app for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/AppUploadRequestBody","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/AppUploadRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}},"schemaId":"schema_520"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}},"schemaId":"components/schemas/Error_403_Forbidden"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-apps/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_520","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_520"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Error_403_Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-apps/paths/~1v2~1tenant-apps/post"}],"panels":[]}]},"httpPath":"/v2/tenant-apps"},{"label":"Get tenant apps for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps/get","routeSlug":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps/get","metadata":{"seo":{"title":"Get tenant apps for a tenant","description":"Get tenant apps for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get tenant apps for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1tenant-apps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tenant apps for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"platform","in":"query","schemaId":"schema_522"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"app_name","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1v2~1tenant-apps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/tenant-apps","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"platform","in":"query","schemaId":"schema_522"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"app_name","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/tenant-apps","href":"4_tenant-apps/paths/~1v2~1tenant-apps/get","summary":"Get tenant apps for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}},"schemaId":"schema_523"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-apps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_523","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_523"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-apps/paths/~1v2~1tenant-apps/get"}],"panels":[]}]},"httpPath":"/v2/tenant-apps"},{"label":"Get tenant app by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}/get","routeSlug":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}/get","metadata":{"seo":{"title":"Get tenant app by ID","description":"Get tenant app by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get tenant app by ID","isWebhook":false,"pointer":"/paths/~1v2~1tenant-apps~1{appId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tenant app by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/tenant-apps/{appId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/tenant-apps/{appId}","href":"4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}/get","summary":"Get tenant app by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_524"}},"schemaId":"schema_524"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_524","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_524"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}/get"}],"panels":[]}]},"httpPath":"/v2/tenant-apps/{appId}"},{"label":"Get tenant app versions by app ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions/get","routeSlug":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions/get","metadata":{"seo":{"title":"Get tenant app versions by app ID","description":"Get tenant app versions by app ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get tenant app versions by app ID","isWebhook":false,"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tenant app versions by app ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"app_name","in":"query","schemaId":"schema_300"},{"name":"legacy_format","in":"query","schemaId":"schema_382","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false, returns version_code instead of build_number. Defaults to true for backward compatibility."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/tenant-apps/{appId}/versions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"app_name","in":"query","schemaId":"schema_300"},{"name":"legacy_format","in":"query","schemaId":"schema_382"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/tenant-apps/{appId}/versions","href":"4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions/get","summary":"Get tenant app versions by app ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_525"}},"schemaId":"schema_525"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_525","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_525"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions/get"}],"panels":[]}]},"httpPath":"/v2/tenant-apps/{appId}/versions"},{"label":"Get tenant app version by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/get","routeSlug":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/get","metadata":{"seo":{"title":"Get tenant app version by ID","description":"Get tenant app version by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get tenant app version by ID","isWebhook":false,"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tenant app version by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_299","required":true},{"name":"versionId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"legacy_format","in":"query","schemaId":"schema_382","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false, returns version_code instead of build_number. Defaults to true for backward compatibility."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/tenant-apps/{appId}/versions/{versionId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_299"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_299"}],"query":[{"name":"legacy_format","in":"query","schemaId":"schema_382"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/tenant-apps/{appId}/versions/{versionId}","href":"4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/get","summary":"Get tenant app version by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}},"schemaId":"schema_526"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_526","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_526"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/get"}],"panels":[]}]},"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}"},{"label":"Update tenant app version by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/put","routeSlug":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/put","metadata":{"seo":{"title":"Update tenant app version by ID","description":"Update tenant app version by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update tenant app version by ID","isWebhook":false,"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update tenant app version by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_300","required":true},{"name":"versionId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_527"}},"schemaId":"schema_527","pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/tenant-apps/{appId}/versions/{versionId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_300"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_527"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v2/tenant-apps/{appId}/versions/{versionId}","href":"4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/put","summary":"Update tenant app version by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_527","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_527"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}},"schemaId":"components/schemas/Error_403_Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Error_403_Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/put"}],"panels":[]}]},"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}"},{"label":"Delete tenant app version by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/delete","routeSlug":"/openapi/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/delete","metadata":{"seo":{"title":"Delete tenant app version by ID","description":"Delete tenant app version by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete tenant app version by ID","isWebhook":false,"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tenant app version by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_299","required":true},{"name":"versionId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/tenant-apps/{appId}/versions/{versionId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_299"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","500"],"pointer":"/v2/tenant-apps/{appId}/versions/{versionId}","href":"4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/delete","summary":"Delete tenant app version by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}},"schemaId":"schema_528"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}},"schemaId":"components/schemas/Error_403_Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-apps~1{appId}~1versions~1{versionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_528","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_528"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Error_403_Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/delete"}],"panels":[]}]},"httpPath":"/v2/tenant-apps/{appId}/versions/{versionId}"}],"content":{"contentType":"group","meta":{"name":"4_Tenant Apps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tenant Apps","showPageActions":true},{"nodeType":"markdoc","content":"API to manage Enterprise iOS apps for a tenant."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/tenant-apps","summary":"Upload tenant app for a tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/4_tenant-apps/paths/~1v2~1tenant-apps/post","deprecated":false},{"title":"/v2/tenant-apps","summary":"Get tenant apps for a tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_tenant-apps/paths/~1v2~1tenant-apps/get","deprecated":false},{"title":"/v2/tenant-apps/{appId}","summary":"Get tenant app by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}/get","deprecated":false},{"title":"/v2/tenant-apps/{appId}/versions","summary":"Get tenant app versions by app ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions/get","deprecated":false},{"title":"/v2/tenant-apps/{appId}/versions/{versionId}","summary":"Get tenant app version by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/get","deprecated":false},{"title":"/v2/tenant-apps/{appId}/versions/{versionId}","summary":"Update tenant app version by ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/put","deprecated":false},{"title":"/v2/tenant-apps/{appId}/versions/{versionId}","summary":"Delete tenant app version by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/4_tenant-apps/paths/~1v2~1tenant-apps~1{appid}~1versions~1{versionid}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Apple App Store","link":"/openapi/4_apple-app-store","routeSlug":"/openapi/4_apple-app-store","items":[{"label":"Search Apple App Store","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_apple-app-store/paths/~1v2~1appleappstore~1/get","routeSlug":"/openapi/4_apple-app-store/paths/~1v2~1appleappstore~1/get","metadata":{"seo":{"title":"Search Apple App Store","description":"Search Apple App Store"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Search Apple App Store","isWebhook":false,"pointer":"/paths/~1v2~1appleappstore~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search Apple App Store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"title","in":"query","schemaId":"schema_300","required":true}],"pointer":"/paths/~1v2~1appleappstore~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/appleappstore/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"title","in":"query","required":true,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/appleappstore/","href":"4_apple-app-store/paths/~1v2~1appleappstore~1/get","summary":"Search Apple App Store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}},"schemaId":"schema_529"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1appleappstore~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_529","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_529"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_apple-app-store/paths/~1v2~1appleappstore~1/get"}],"panels":[]}]},"httpPath":"/v2/appleappstore/"}],"content":{"contentType":"group","meta":{"name":"4_Apple App Store"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apple App Store","showPageActions":true},{"nodeType":"markdoc","content":"API to search apple app store for apps"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/appleappstore/","summary":"Search Apple App Store","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_apple-app-store/paths/~1v2~1appleappstore~1/get","deprecated":false}]}]}]}]}},{"type":"group","label":"App List","link":"/openapi/4_app-list","routeSlug":"/openapi/4_app-list","items":[{"label":"Get unified list of iOS apps (IPAs and Webclips) for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_app-list/paths/~1v2~1apps/get","routeSlug":"/openapi/4_app-list/paths/~1v2~1apps/get","metadata":{"seo":{"title":"Get unified list of iOS apps (IPAs and Webclips) for a tenant","description":"Get unified list of iOS apps (IPAs and Webclips) for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get unified list of iOS apps (IPAs and Webclips) for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1apps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get unified list of iOS apps (IPAs and Webclips) for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"search","in":"query","schemaId":"schema_300"},{"name":"ordering","in":"query","schemaId":"schema_530"},{"name":"app_type","in":"query","schemaId":"schema_300"},{"name":"legacy_format","in":"query","schemaId":"schema_382","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false, returns version_code instead of build_number. Defaults to true for backward compatibility."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1apps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/apps","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"search","in":"query","schemaId":"schema_300"},{"name":"ordering","in":"query","schemaId":"schema_530"},{"name":"app_type","in":"query","schemaId":"schema_300"},{"name":"legacy_format","in":"query","schemaId":"schema_382"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/apps","href":"4_app-list/paths/~1v2~1apps/get","summary":"Get unified list of iOS apps (IPAs and Webclips) for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}},"schemaId":"schema_531"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1apps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_531","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_531"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_app-list/paths/~1v2~1apps/get"}],"panels":[]}]},"httpPath":"/v2/apps"}],"content":{"contentType":"group","meta":{"name":"4_App List"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"App List","showPageActions":true},{"nodeType":"markdoc","content":"Unified API to query Webclips and Tenant IOS Apps"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/apps","summary":"Get unified list of iOS apps (IPAs and Webclips) for a tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_app-list/paths/~1v2~1apps/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Webclips","link":"/openapi/4_webclips","routeSlug":"/openapi/4_webclips","items":[{"label":"Create webclip for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_webclips/paths/~1v2~1webclips/post","routeSlug":"/openapi/4_webclips/paths/~1v2~1webclips/post","metadata":{"seo":{"title":"Create webclip for a tenant","description":"Create webclip for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create webclip for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1webclips/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create webclip for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/WebclipCreateRequest"}},"schemaId":"components/schemas/WebclipCreateRequest","pointer":"/paths/~1v2~1webclips/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/webclips","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/WebclipCreateRequest"}},"responseCodes":["200","400","401","409","500"],"pointer":"/v2/webclips","href":"4_webclips/paths/~1v2~1webclips/post","summary":"Create webclip for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/WebclipCreateRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/WebclipCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}},"schemaId":"components/schemas/Error_409_Conflict"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1webclips/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"409","schemaId":"components/schemas/Error_409_Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_webclips/paths/~1v2~1webclips/post"}],"panels":[]}]},"httpPath":"/v2/webclips"},{"label":"Get webclips for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_webclips/paths/~1v2~1webclips/get","routeSlug":"/openapi/4_webclips/paths/~1v2~1webclips/get","metadata":{"seo":{"title":"Get webclips for a tenant","description":"Get webclips for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get webclips for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1webclips/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webclips for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"label","in":"query","schemaId":"schema_300"},{"name":"exact_esper_name","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1v2~1webclips/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webclips","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"label","in":"query","schemaId":"schema_300"},{"name":"exact_esper_name","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/webclips","href":"4_webclips/paths/~1v2~1webclips/get","summary":"Get webclips for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_533"}},"schemaId":"schema_533"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1webclips/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_533","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_533"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_webclips/paths/~1v2~1webclips/get"}],"panels":[]}]},"httpPath":"/v2/webclips"},{"label":"Get webclip by id for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_webclips/paths/~1v2~1webclips~1{webclipid}/get","routeSlug":"/openapi/4_webclips/paths/~1v2~1webclips~1{webclipid}/get","metadata":{"seo":{"title":"Get webclip by id for a tenant","description":"Get webclip by id for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get webclip by id for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1webclips~1{webclipId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get webclip by id for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webclipId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1webclips~1{webclipId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/webclips/{webclipId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"webclipId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/webclips/{webclipId}","href":"4_webclips/paths/~1v2~1webclips~1{webclipid}/get","summary":"Get webclip by id for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1webclips~1{webclipId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_webclips/paths/~1v2~1webclips~1{webclipid}/get"}],"panels":[]}]},"httpPath":"/v2/webclips/{webclipId}"},{"label":"Delete webclip for a tenant","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_webclips/paths/~1v2~1webclips~1{webclipid}/delete","routeSlug":"/openapi/4_webclips/paths/~1v2~1webclips~1{webclipid}/delete","metadata":{"seo":{"title":"Delete webclip for a tenant","description":"Delete webclip for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete webclip for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1webclips~1{webclipId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete webclip for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webclipId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1webclips~1{webclipId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/webclips/{webclipId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"webclipId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","409","500"],"pointer":"/v2/webclips/{webclipId}","href":"4_webclips/paths/~1v2~1webclips~1{webclipid}/delete","summary":"Delete webclip for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}},"schemaId":"schema_532"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}},"schemaId":"components/schemas/Error_409_Conflict"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1webclips~1{webclipId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_532","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_532"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"409","schemaId":"components/schemas/Error_409_Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_webclips/paths/~1v2~1webclips~1{webclipid}/delete"}],"panels":[]}]},"httpPath":"/v2/webclips/{webclipId}"}],"content":{"contentType":"group","meta":{"name":"4_Webclips"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webclips","showPageActions":true},{"nodeType":"markdoc","content":"API to manage webclips for a tenant"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/webclips","summary":"Create webclip for a tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/4_webclips/paths/~1v2~1webclips/post","deprecated":false},{"title":"/v2/webclips","summary":"Get webclips for a tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_webclips/paths/~1v2~1webclips/get","deprecated":false},{"title":"/v2/webclips/{webclipId}","summary":"Get webclip by id for a tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_webclips/paths/~1v2~1webclips~1{webclipid}/get","deprecated":false},{"title":"/v2/webclips/{webclipId}","summary":"Delete webclip for a tenant","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/4_webclips/paths/~1v2~1webclips~1{webclipid}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Provisioning Profiles","link":"/openapi/4_provisioning-profiles","routeSlug":"/openapi/4_provisioning-profiles","items":[{"label":"Upload provisioning profile for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/post","routeSlug":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/post","metadata":{"seo":{"title":"Upload provisioning profile for a tenant","description":"API to upload and validate iOS provisioning profiles for app distribution"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload provisioning profile for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1provisioning-profiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload provisioning profile for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to upload and validate iOS provisioning profiles for app distribution"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ProvisioningProfileUploadRequest"}},"schemaId":"components/schemas/ProvisioningProfileUploadRequest","pointer":"/paths/~1v2~1provisioning-profiles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/provisioning-profiles","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/ProvisioningProfileUploadRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/provisioning-profiles","href":"4_provisioning-profiles/paths/~1v2~1provisioning-profiles/post","summary":"Upload provisioning profile for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/ProvisioningProfileUploadRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/ProvisioningProfileUploadRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}},"schemaId":"schema_534"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1provisioning-profiles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_534","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_534"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/post"}],"panels":[]}]},"httpPath":"/v2/provisioning-profiles"},{"label":"Get provisioning profiles for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/get","routeSlug":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/get","metadata":{"seo":{"title":"Get provisioning profiles for a tenant","description":"API to retrieve a list of iOS provisioning profiles with download URLs and pagination"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get provisioning profiles for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1provisioning-profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get provisioning profiles for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to retrieve a list of iOS provisioning profiles with download URLs and pagination"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_535"},{"name":"offset","in":"query","schemaId":"schema_536"},{"name":"app_identifier","in":"query","schemaId":"schema_537"},{"name":"profile_type","in":"query","schemaId":"schema_538"},{"name":"team_id","in":"query","schemaId":"schema_539"},{"name":"search","in":"query","schemaId":"schema_540"}],"pointer":"/paths/~1v2~1provisioning-profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/provisioning-profiles","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_535"},{"name":"offset","in":"query","schemaId":"schema_536"},{"name":"app_identifier","in":"query","schemaId":"schema_537"},{"name":"profile_type","in":"query","schemaId":"schema_538"},{"name":"team_id","in":"query","schemaId":"schema_539"},{"name":"search","in":"query","schemaId":"schema_540"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/provisioning-profiles","href":"4_provisioning-profiles/paths/~1v2~1provisioning-profiles/get","summary":"Get provisioning profiles for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_541"}},"schemaId":"schema_541"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1provisioning-profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_541","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_541"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/get"}],"panels":[]}]},"httpPath":"/v2/provisioning-profiles"},{"label":"Get provisioning profile by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}/get","routeSlug":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}/get","metadata":{"seo":{"title":"Get provisioning profile by ID","description":"API to retrieve a specific iOS provisioning profile by its ID with download URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get provisioning profile by ID","isWebhook":false,"pointer":"/paths/~1v2~1provisioning-profiles~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get provisioning profile by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to retrieve a specific iOS provisioning profile by its ID with download URL"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_542","required":true}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/provisioning-profiles/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_542"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/provisioning-profiles/{id}","href":"4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}/get","summary":"Get provisioning profile by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}},"schemaId":"schema_543"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_543","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}/get"}],"panels":[]}]},"httpPath":"/v2/provisioning-profiles/{id}"},{"label":"Get provisioning profile versions list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions/get","routeSlug":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions/get","metadata":{"seo":{"title":"Get provisioning profile versions list","description":"API to retrieve all versions of a specific iOS provisioning profile ordered by expiration date descending, with pagination and search capabilities"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get provisioning profile versions list","isWebhook":false,"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get provisioning profile versions list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to retrieve all versions of a specific iOS provisioning profile ordered by expiration date descending, with pagination and search capabilities"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_542","required":true}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_544"},{"name":"offset","in":"query","schemaId":"schema_545"},{"name":"search","in":"query","schemaId":"schema_546"}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/provisioning-profiles/{id}/versions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_542"}],"query":[{"name":"limit","in":"query","schemaId":"schema_544"},{"name":"offset","in":"query","schemaId":"schema_545"},{"name":"search","in":"query","schemaId":"schema_546"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/provisioning-profiles/{id}/versions","href":"4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions/get","summary":"Get provisioning profile versions list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_547"}},"schemaId":"schema_547"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_547","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_547"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions/get"}],"panels":[]}]},"httpPath":"/v2/provisioning-profiles/{id}/versions"},{"label":"Get provisioning profile version by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/get","routeSlug":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/get","metadata":{"seo":{"title":"Get provisioning profile version by ID","description":"API to retrieve a specific version of an iOS provisioning profile by profile ID and version ID with download URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get provisioning profile version by ID","isWebhook":false,"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get provisioning profile version by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to retrieve a specific version of an iOS provisioning profile by profile ID and version ID with download URL"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_542","required":true},{"name":"versionId","in":"path","schemaId":"schema_548","required":true}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/provisioning-profiles/{id}/versions/{versionId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_542"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_548"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/provisioning-profiles/{id}/versions/{versionId}","href":"4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/get","summary":"Get provisioning profile version by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/get"}],"panels":[]}]},"httpPath":"/v2/provisioning-profiles/{id}/versions/{versionId}"},{"label":"Delete provisioning profile version by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/delete","routeSlug":"/openapi/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/delete","metadata":{"seo":{"title":"Delete provisioning profile version by ID","description":"API to delete a specific version of an iOS provisioning profile by profile ID and version ID. Returns the deleted version information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete provisioning profile version by ID","isWebhook":false,"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete provisioning profile version by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to delete a specific version of an iOS provisioning profile by profile ID and version ID. Returns the deleted version information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_542","required":true},{"name":"versionId","in":"path","schemaId":"schema_550","required":true}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/provisioning-profiles/{id}/versions/{versionId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_542"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_550"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/provisioning-profiles/{id}/versions/{versionId}","href":"4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/delete","summary":"Delete provisioning profile version by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/delete"}],"panels":[]}]},"httpPath":"/v2/provisioning-profiles/{id}/versions/{versionId}"}],"content":{"contentType":"group","meta":{"name":"4_Provisioning Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provisioning Profiles","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing iOS provisioning profiles for app distribution"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/provisioning-profiles","summary":"Upload provisioning profile for a tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/post","deprecated":false},{"title":"/v2/provisioning-profiles","summary":"Get provisioning profiles for a tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles/get","deprecated":false},{"title":"/v2/provisioning-profiles/{id}","summary":"Get provisioning profile by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}/get","deprecated":false},{"title":"/v2/provisioning-profiles/{id}/versions","summary":"Get provisioning profile versions list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions/get","deprecated":false},{"title":"/v2/provisioning-profiles/{id}/versions/{versionId}","summary":"Get provisioning profile version by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/get","deprecated":false},{"title":"/v2/provisioning-profiles/{id}/versions/{versionId}","summary":"Delete provisioning profile version by ID","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/4_provisioning-profiles/paths/~1v2~1provisioning-profiles~1{id}~1versions~1{versionid}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Preferred Regions","link":"/openapi/4_preferred-regions","routeSlug":"/openapi/4_preferred-regions","items":[{"label":"Set Preferred Regions for Tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_preferred-regions/paths/~1v2~1preferred-regions/post","routeSlug":"/openapi/4_preferred-regions/paths/~1v2~1preferred-regions/post","metadata":{"seo":{"title":"Set Preferred Regions for Tenant","description":"API to set the preferred country/region list for a tenant. This overwrites any existing value (upsert). Country codes must be valid ISO 3166-1 alpha-2 codes (2-character uppercase)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Set Preferred Regions for Tenant","isWebhook":false,"pointer":"/paths/~1v2~1preferred-regions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set Preferred Regions for Tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to set the preferred country/region list for a tenant. This overwrites any existing value (upsert). Country codes must be valid ISO 3166-1 alpha-2 codes (2-character uppercase)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetPreferredRegionsRequest"}},"schemaId":"components/schemas/SetPreferredRegionsRequest","pointer":"/paths/~1v2~1preferred-regions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/preferred-regions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SetPreferredRegionsRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/preferred-regions","href":"4_preferred-regions/paths/~1v2~1preferred-regions/post","summary":"Set Preferred Regions for Tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/SetPreferredRegionsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SetPreferredRegionsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_551"}},"schemaId":"schema_551"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1preferred-regions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_551"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_preferred-regions/paths/~1v2~1preferred-regions/post"}],"panels":[]}]},"httpPath":"/v2/preferred-regions"},{"label":"Get Preferred Regions for Tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_preferred-regions/paths/~1v2~1preferred-regions/get","routeSlug":"/openapi/4_preferred-regions/paths/~1v2~1preferred-regions/get","metadata":{"seo":{"title":"Get Preferred Regions for Tenant","description":"API to get the preferred country/region list for a tenant. Returns an empty countries array if no regions have been set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Preferred Regions for Tenant","isWebhook":false,"pointer":"/paths/~1v2~1preferred-regions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Preferred Regions for Tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get the preferred country/region list for a tenant. Returns an empty countries array if no regions have been set."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/preferred-regions","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v2/preferred-regions","href":"4_preferred-regions/paths/~1v2~1preferred-regions/get","summary":"Get Preferred Regions for Tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_551"}},"schemaId":"schema_551"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1preferred-regions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_551"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_preferred-regions/paths/~1v2~1preferred-regions/get"}],"panels":[]}]},"httpPath":"/v2/preferred-regions"}],"content":{"contentType":"group","meta":{"name":"4_Preferred Regions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Preferred Regions","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing a tenant's preferred country/region list for App Store lookups"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/preferred-regions","summary":"Set Preferred Regions for Tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/4_preferred-regions/paths/~1v2~1preferred-regions/post","deprecated":false},{"title":"/v2/preferred-regions","summary":"Get Preferred Regions for Tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_preferred-regions/paths/~1v2~1preferred-regions/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Esper Apps","link":"/openapi/4_esper-apps","routeSlug":"/openapi/4_esper-apps","items":[{"label":"Get esper app version details by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_esper-apps/paths/~1v2~1esper-apps~1{appid}~1versions~1{versionid}/get","routeSlug":"/openapi/4_esper-apps/paths/~1v2~1esper-apps~1{appid}~1versions~1{versionid}/get","metadata":{"seo":{"title":"Get esper app version details by ID","description":"Get esper app version details by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get esper app version details by ID","isWebhook":false,"pointer":"/paths/~1v2~1esper-apps~1{appId}~1versions~1{versionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get esper app version details by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appId","in":"path","schemaId":"schema_299","required":true},{"name":"versionId","in":"path","schemaId":"schema_299","required":true}],"pointer":"/paths/~1v2~1esper-apps~1{appId}~1versions~1{versionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/esper-apps/{appId}/versions/{versionId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"appId","in":"path","required":true,"schemaId":"schema_299"},{"name":"versionId","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v2/esper-apps/{appId}/versions/{versionId}","href":"4_esper-apps/paths/~1v2~1esper-apps~1{appid}~1versions~1{versionid}/get","summary":"Get esper app version details by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_552"}},"schemaId":"schema_552"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1esper-apps~1{appId}~1versions~1{versionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_552","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_552"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_esper-apps/paths/~1v2~1esper-apps~1{appid}~1versions~1{versionid}/get"}],"panels":[]}]},"httpPath":"/v2/esper-apps/{appId}/versions/{versionId}"}],"content":{"contentType":"group","meta":{"name":"4_Esper Apps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Esper Apps","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/esper-apps/{appId}/versions/{versionId}","summary":"Get esper app version details by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_esper-apps/paths/~1v2~1esper-apps~1{appid}~1versions~1{versionid}/get","deprecated":false}]}]}]}]}},{"type":"group","label":"Tenant Esper Apps","link":"/openapi/4_tenant-esper-apps","routeSlug":"/openapi/4_tenant-esper-apps","items":[{"label":"Get esper apps for a tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/4_tenant-esper-apps/paths/~1v2~1tenant-esper-apps/get","routeSlug":"/openapi/4_tenant-esper-apps/paths/~1v2~1tenant-esper-apps/get","metadata":{"seo":{"title":"Get esper apps for a tenant","description":"Get esper apps for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get esper apps for a tenant","isWebhook":false,"pointer":"/paths/~1v2~1tenant-esper-apps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get esper apps for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"ordering","in":"query","schemaId":"schema_553"},{"name":"architecture","in":"query","schemaId":"schema_554"},{"name":"version_code","in":"query","schemaId":"schema_555"}],"pointer":"/paths/~1v2~1tenant-esper-apps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/tenant-esper-apps","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"},{"name":"package_name","in":"query","schemaId":"schema_300"},{"name":"ordering","in":"query","schemaId":"schema_553"},{"name":"architecture","in":"query","schemaId":"schema_554"},{"name":"version_code","in":"query","schemaId":"schema_555"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/tenant-esper-apps","href":"4_tenant-esper-apps/paths/~1v2~1tenant-esper-apps/get","summary":"Get esper apps for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}},"schemaId":"schema_556"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1tenant-esper-apps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_556","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_556"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/4_tenant-esper-apps/paths/~1v2~1tenant-esper-apps/get"}],"panels":[]}]},"httpPath":"/v2/tenant-esper-apps"}],"content":{"contentType":"group","meta":{"name":"4_Tenant Esper Apps"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tenant Esper Apps","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/tenant-esper-apps","summary":"Get esper apps for a tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/4_tenant-esper-apps/paths/~1v2~1tenant-esper-apps/get","deprecated":false}]}]}]}]}},{"type":"separator","label":"COMMANDS","content":null},{"type":"group","label":"Command Request","link":"/openapi/5_command-request","routeSlug":"/openapi/5_command-request","items":[{"label":"List command requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-request/listcommandrequests","routeSlug":"/openapi/5_command-request/listcommandrequests","metadata":{"seo":{"title":"List command requests","description":"API to get and filter command requests"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCommandRequests","name":"List command requests","isWebhook":false,"pointer":"/paths/~1commands~1v0~1commands~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List command requests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get and filter command requests"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"devices","in":"query","schemaId":"schema_300","description":"Filter by device IDs. Accepts comma separated values."},{"name":"groups","in":"query","schemaId":"schema_300","description":"Filter by group IDs. Accepts comma separated values."},{"name":"command","in":"query","schemaId":"schema_300","description":"Filter by command name"},{"name":"schedule","in":"query","schemaId":"schema_557","description":"Filter by schedule type"},{"name":"exclude_internal_commands","in":"query","schemaId":"schema_303","description":"Filter to exclude internal commands"},{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"pointer":"/paths/~1commands~1v0~1commands~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commands/v0/commands/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"devices","in":"query","schemaId":"schema_300"},{"name":"groups","in":"query","schemaId":"schema_300"},{"name":"command","in":"query","schemaId":"schema_300"},{"name":"schedule","in":"query","schemaId":"schema_557"},{"name":"exclude_internal_commands","in":"query","schemaId":"schema_303"},{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/commands/v0/commands/","href":"5_command-request/listcommandrequests","openApiOperationId":"listCommandRequests","summary":"List command requests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Command request list for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_558"}},"schemaId":"schema_558"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1commands~1v0~1commands~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_558","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_558"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-request/listcommandrequests"}],"panels":[]}]},"httpPath":"/commands/v0/commands/"},{"label":"Create a command request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-request/createcommandrequest","routeSlug":"/openapi/5_command-request/createcommandrequest","metadata":{"seo":{"title":"Create a command request","description":"API to create a command request for a set of devices or groups. Works for mixed-fleet devices (Android, iOS, etc.) if the command is supported."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCommandRequest","name":"Create a command request","isWebhook":false,"pointer":"/paths/~1commands~1v0~1commands~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a command request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API to create a command request for a set of devices or groups. Works for mixed-fleet devices (Android, iOS, etc.) if the command is supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can send the command immediately or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/16693582666769-Scheduling-API-Commands"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule command"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for supported devices."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled commands are currently compatible with Android devices."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommandRequest_POST"}},"schemaId":"components/schemas/CommandRequest_POST","pointer":"/paths/~1commands~1v0~1commands~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/commands/v0/commands/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommandRequest_POST"}},"responseCodes":["201","400","401","500"],"pointer":"/commands/v0/commands/","href":"5_command-request/createcommandrequest","openApiOperationId":"createCommandRequest","summary":"Create a command request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/CommandRequest_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommandRequest_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Command request successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1commands~1v0~1commands~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-request/createcommandrequest"}],"panels":[]}]},"httpPath":"/commands/v0/commands/"},{"label":"Get a command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-request/getcommandrequest","routeSlug":"/openapi/5_command-request/getcommandrequest","metadata":{"seo":{"title":"Get a command request","description":"API to get a command request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommandRequest","name":"Get a command request","isWebhook":false,"pointer":"/paths/~1commands~1v0~1commands~1{id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a command request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get a command request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the command request object","required":true}],"pointer":"/paths/~1commands~1v0~1commands~1{id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commands/v0/commands/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/commands/v0/commands/{id}/","href":"5_command-request/getcommandrequest","openApiOperationId":"getCommandRequest","summary":"Get a command request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Command request information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1commands~1v0~1commands~1{id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-request/getcommandrequest"}],"panels":[]}]},"httpPath":"/commands/v0/commands/{id}/"},{"label":"Get stats of a command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-request/getcommandrequeststats","routeSlug":"/openapi/5_command-request/getcommandrequeststats","metadata":{"seo":{"title":"Get stats of a command request","description":"API to get a aggregrated status for a command request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommandRequestStats","name":"Get stats of a command request","isWebhook":false,"pointer":"/paths/~1commands~1v0~1commands~1{id}~1stats~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get stats of a command request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get a aggregrated status for a command request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the command request object","required":true}],"pointer":"/paths/~1commands~1v0~1commands~1{id}~1stats~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commands/v0/commands/{id}/stats/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/commands/v0/commands/{id}/stats/","href":"5_command-request/getcommandrequeststats","openApiOperationId":"getCommandRequestStats","summary":"Get stats of a command request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Aggregrated status information for a command request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1commands~1v0~1commands~1{id}~1stats~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-request/getcommandrequeststats"}],"panels":[]}]},"httpPath":"/commands/v0/commands/{id}/stats/"}],"content":{"contentType":"group","meta":{"name":"5_Command Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Command Request","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to view and manage command requests. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/16036992814609-Commonly-Used-APIs#h_01H2GZ8WM86BSQBGXE998QY8SM"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"commands"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or how to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/16036992814609-Commonly-Used-APIs#h_01H2GZ8WM86BSQBGXE998QY8SM"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule a command"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled commands are currently compatible with Android devices."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/commands/v0/commands/","summary":"List command requests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/5_command-request/listcommandrequests","deprecated":false},{"title":"/commands/v0/commands/","summary":"Create a command request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/5_command-request/createcommandrequest","deprecated":false},{"title":"/commands/v0/commands/{id}/","summary":"Get a command request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/5_command-request/getcommandrequest","deprecated":false},{"title":"/commands/v0/commands/{id}/stats/","summary":"Get stats of a command request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/5_command-request/getcommandrequeststats","deprecated":false}]}]}]}]}},{"type":"group","label":"Command Status","link":"/openapi/5_command-status","routeSlug":"/openapi/5_command-status","items":[{"label":"Get status list for command request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-status/getcommandrequeststatuses","routeSlug":"/openapi/5_command-status/getcommandrequeststatuses","metadata":{"seo":{"title":"Get status list for command request","description":"API to get and filter command request status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommandRequestStatuses","name":"Get status list for command request","isWebhook":false,"pointer":"/paths/~1commands~1v0~1status~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get status list for command request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get and filter command request status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"request","in":"query","schemaId":"schema_300","description":"Filter status result by command request IDs. Accepts comma separated values."},{"name":"device","in":"query","schemaId":"schema_300","description":"Filter status result by device IDs. Accepts comma separated values."},{"name":"state","in":"query","schemaId":"schema_561","description":"Filter by command state"},{"name":"exclude_internal_commands","in":"query","schemaId":"schema_303","description":"Filter to exclude internal commands"},{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"pointer":"/paths/~1commands~1v0~1status~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commands/v0/status/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"request","in":"query","schemaId":"schema_300"},{"name":"device","in":"query","schemaId":"schema_300"},{"name":"state","in":"query","schemaId":"schema_561"},{"name":"exclude_internal_commands","in":"query","schemaId":"schema_303"},{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/commands/v0/status/","href":"5_command-status/getcommandrequeststatuses","openApiOperationId":"getCommandRequestStatuses","summary":"Get status list for command request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Status list for a command request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_562"}},"schemaId":"schema_562"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1commands~1v0~1status~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_562","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_562"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-status/getcommandrequeststatuses"}],"panels":[]}]},"httpPath":"/commands/v0/status/"},{"label":"Get a command status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-status/getcommandstatus","routeSlug":"/openapi/5_command-status/getcommandstatus","metadata":{"seo":{"title":"Get a command status","description":"API to get a command status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommandStatus","name":"Get a command status","isWebhook":false,"pointer":"/paths/~1commands~1v0~1status~1{id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a command status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get a command status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the command status object","required":true}],"pointer":"/paths/~1commands~1v0~1status~1{id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/commands/v0/status/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/commands/v0/status/{id}/","href":"5_command-status/getcommandstatus","openApiOperationId":"getCommandStatus","summary":"Get a command status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Command status information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1commands~1v0~1status~1{id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-status/getcommandstatus"}],"panels":[]}]},"httpPath":"/commands/v0/status/{id}/"},{"label":"Update command status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-status/updatecommandstatus","routeSlug":"/openapi/5_command-status/updatecommandstatus","metadata":{"seo":{"title":"Update command status","description":"API to update a command status state"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCommandStatus","name":"Update command status","isWebhook":false,"pointer":"/paths/~1commands~1v0~1status~1{id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update command status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to update a command status state"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the command status object","required":true}],"pointer":"/paths/~1commands~1v0~1status~1{id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommandStatus_PUT"}},"schemaId":"components/schemas/CommandStatus_PUT","pointer":"/paths/~1commands~1v0~1status~1{id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/commands/v0/status/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CommandStatus_PUT"}},"responseCodes":["200","400","401","500"],"pointer":"/commands/v0/status/{id}/","href":"5_command-status/updatecommandstatus","openApiOperationId":"updateCommandStatus","summary":"Update command status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/CommandStatus_PUT","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CommandStatus_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Command status successfully updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1commands~1v0~1status~1{id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-status/updatecommandstatus"}],"panels":[]}]},"httpPath":"/commands/v0/status/{id}/"},{"label":"Get queued commands to be executed by the physical device.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/5_command-status/getcommandinbox","routeSlug":"/openapi/5_command-status/getcommandinbox","metadata":{"seo":{"title":"Get queued commands to be executed by the physical device.","description":"API to get queued commands for a device"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCommandInbox","name":"Get queued commands to be executed by the physical device.","isWebhook":false,"pointer":"/paths/~1v2~1command-inbox~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get queued commands to be executed by the physical device.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get queued commands for a device"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"device_id","in":"query","schemaId":"schema_300","description":"Filter status result by device IDs.","required":true}],"pointer":"/paths/~1v2~1command-inbox~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/command-inbox/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"device_id","in":"query","required":true,"schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v2/command-inbox/","href":"5_command-status/getcommandinbox","openApiOperationId":"getCommandInbox","summary":"Get queued commands to be executed by the physical device."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Queued Command Status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_564"}},"schemaId":"schema_564"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1command-inbox~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_564","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_564"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/5_command-status/getcommandinbox"}],"panels":[]}]},"httpPath":"/v2/command-inbox/"}],"content":{"contentType":"group","meta":{"name":"5_Command Status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Command Status","showPageActions":true},{"nodeType":"markdoc","content":"APIs to view, filter, and manage command requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/commands/v0/status/","summary":"Get status list for command request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/5_command-status/getcommandrequeststatuses","deprecated":false},{"title":"/commands/v0/status/{id}/","summary":"Get a command status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/5_command-status/getcommandstatus","deprecated":false},{"title":"/commands/v0/status/{id}/","summary":"Update command status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/5_command-status/updatecommandstatus","deprecated":false},{"title":"/v2/command-inbox/","summary":"Get queued commands to be executed by the physical device.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/5_command-status/getcommandinbox","deprecated":false}]}]}]}]}},{"type":"separator","label":"DRIFT","content":null},{"type":"group","label":"Converge","link":"/openapi/6_converge","routeSlug":"/openapi/6_converge","items":[{"label":"List converge action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/6_converge/listconverges","routeSlug":"/openapi/6_converge/listconverges","metadata":{"seo":{"title":"List converge action","description":"API to get and filter converge action"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConverges","name":"List converge action","isWebhook":false,"pointer":"/paths/~1v2~1converge/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List converge action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get and filter converge action"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"device_ids","in":"query","schemaId":"schema_300","description":"Filter by device IDs. Accepts comma separated values."},{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"pointer":"/paths/~1v2~1converge/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/converge","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"device_ids","in":"query","schemaId":"schema_300"},{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v2/converge","href":"6_converge/listconverges","openApiOperationId":"listConverges","summary":"List converge action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Converge action list for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}},"schemaId":"schema_565"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1converge/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_565","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/6_converge/listconverges"}],"panels":[]}]},"httpPath":"/v2/converge"},{"label":"Create a converge action","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/6_converge/createconverge","routeSlug":"/openapi/6_converge/createconverge","metadata":{"seo":{"title":"Create a converge action","description":"API to create a converge action for a device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createConverge","name":"Create a converge action","isWebhook":false,"pointer":"/paths/~1v2~1converge/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a converge action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to create a converge action for a device."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Converge_POST"}},"schemaId":"components/schemas/Converge_POST","pointer":"/paths/~1v2~1converge/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/converge","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Converge_POST"}},"responseCodes":["201","400","401","500"],"pointer":"/v2/converge","href":"6_converge/createconverge","openApiOperationId":"createConverge","summary":"Create a converge action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Converge_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Converge_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Converge action successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_566"}},"schemaId":"schema_566"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1converge/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_566","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_566"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/6_converge/createconverge"}],"panels":[]}]},"httpPath":"/v2/converge"},{"label":"Get converge action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/6_converge/getconverge","routeSlug":"/openapi/6_converge/getconverge","metadata":{"seo":{"title":"Get converge action","description":"API to get a converge action"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getConverge","name":"Get converge action","isWebhook":false,"pointer":"/paths/~1v2~1converge~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get converge action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get a converge action"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the converge object","required":true}],"pointer":"/paths/~1v2~1converge~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/converge/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v2/converge/{id}","href":"6_converge/getconverge","openApiOperationId":"getConverge","summary":"Get converge action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Converge information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_566"}},"schemaId":"schema_566"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1converge~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_566","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_566"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/6_converge/getconverge"}],"panels":[]}]},"httpPath":"/v2/converge/{id}"}],"content":{"contentType":"group","meta":{"name":"6_Converge"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Converge","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to list and create converge actions for devices. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/24210344910865-Blueprint-Converge-and-Revert"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"converge"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/converge","summary":"List converge action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/6_converge/listconverges","deprecated":false},{"title":"/v2/converge","summary":"Create a converge action","prefix":{"name":"post","color":"post"},"badges":[],"link":"/6_converge/createconverge","deprecated":false},{"title":"/v2/converge/{id}","summary":"Get converge action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/6_converge/getconverge","deprecated":false}]}]}]}]}},{"type":"group","label":"Converge Command","link":"/openapi/6_converge-command","routeSlug":"/openapi/6_converge-command","items":[{"label":"List commands fires for converge action","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/6_converge-command/listconvergecommands","routeSlug":"/openapi/6_converge-command/listconvergecommands","metadata":{"seo":{"title":"List commands fires for converge action","description":"API to get and filter commands fired for converge action"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConvergeCommands","name":"List commands fires for converge action","isWebhook":false,"pointer":"/paths/~1v2~1converge~1{id}~1commands/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List commands fires for converge action","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get and filter commands fired for converge action"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the converge object","required":true}],"pointer":"/paths/~1v2~1converge~1{id}~1commands/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"pointer":"/paths/~1v2~1converge~1{id}~1commands/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/converge/{id}/commands","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[{"name":"limit","in":"query","schemaId":"schema_521"},{"name":"offset","in":"query","schemaId":"schema_521"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v2/converge/{id}/commands","href":"6_converge-command/listconvergecommands","openApiOperationId":"listConvergeCommands","summary":"List commands fires for converge action"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of commands fired for converge action for the tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_567"}},"schemaId":"schema_567"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1converge~1{id}~1commands/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_567","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_567"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/6_converge-command/listconvergecommands"}],"panels":[]}]},"httpPath":"/v2/converge/{id}/commands"}],"content":{"contentType":"group","meta":{"name":"6_Converge Command"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Converge Command","showPageActions":true},{"nodeType":"markdoc","content":"API for converge command"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/converge/{id}/commands","summary":"List commands fires for converge action","prefix":{"name":"get","color":"get"},"badges":[],"link":"/6_converge-command/listconvergecommands","deprecated":false}]}]}]}]}},{"type":"separator","label":"DEVICE ONBOARDING","content":null},{"type":"group","label":"DEP Sync Request","link":"/openapi/7_dep-sync-request","routeSlug":"/openapi/7_dep-sync-request","items":[{"label":"List all DEP sync requests for the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/7_dep-sync-request/listdepsyncrequest","routeSlug":"/openapi/7_dep-sync-request/listdepsyncrequest","metadata":{"seo":{"title":"List all DEP sync requests for the tenant","description":"Returns all the DEP sync requests for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDEPSyncRequest","name":"List all DEP sync requests for the tenant","isWebhook":false,"pointer":"/paths/~1onboarding~1v0~1depsyncs~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all DEP sync requests for the tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the DEP sync requests for the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/onboarding/v0/depsyncs/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/onboarding/v0/depsyncs/","href":"7_dep-sync-request/listdepsyncrequest","openApiOperationId":"listDEPSyncRequest","summary":"List all DEP sync requests for the tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"DEP sync request list for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}},"schemaId":"schema_568"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1onboarding~1v0~1depsyncs~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_568","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/7_dep-sync-request/listdepsyncrequest"}],"panels":[]}]},"httpPath":"/onboarding/v0/depsyncs/"},{"label":"Create a DEP sync request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/7_dep-sync-request/createdepsyncrequest","routeSlug":"/openapi/7_dep-sync-request/createdepsyncrequest","metadata":{"seo":{"title":"Create a DEP sync request","description":"API to create a DEP sync request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDEPSyncRequest","name":"Create a DEP sync request","isWebhook":false,"pointer":"/paths/~1onboarding~1v0~1depsyncs~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a DEP sync request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to create a DEP sync request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"schemaId":"components/schemas/PipelineRun_POST","pointer":"/paths/~1onboarding~1v0~1depsyncs~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/onboarding/v0/depsyncs/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"responseCodes":["200","400","401","500"],"pointer":"/onboarding/v0/depsyncs/","href":"7_dep-sync-request/createdepsyncrequest","openApiOperationId":"createDEPSyncRequest","summary":"Create a DEP sync request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/PipelineRun_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"DEP sync request successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}},"schemaId":"schema_569"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1onboarding~1v0~1depsyncs~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_569","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/7_dep-sync-request/createdepsyncrequest"}],"panels":[]}]},"httpPath":"/onboarding/v0/depsyncs/"},{"label":"Get a DEP sync request","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/7_dep-sync-request/getdepsyncrequest","routeSlug":"/openapi/7_dep-sync-request/getdepsyncrequest","metadata":{"seo":{"title":"Get a DEP sync request","description":"API to get a DEP sync request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDEPSyncRequest","name":"Get a DEP sync request","isWebhook":false,"pointer":"/paths/~1onboarding~1v0~1depsyncs~1{id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a DEP sync request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to get a DEP sync request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the DEP sync request object","required":true}],"pointer":"/paths/~1onboarding~1v0~1depsyncs~1{id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/onboarding/v0/depsyncs/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/onboarding/v0/depsyncs/{id}/","href":"7_dep-sync-request/getdepsyncrequest","openApiOperationId":"getDEPSyncRequest","summary":"Get a DEP sync request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"DEP sync request information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_570"}},"schemaId":"schema_570"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1onboarding~1v0~1depsyncs~1{id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_570","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_570"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/7_dep-sync-request/getdepsyncrequest"}],"panels":[]}]},"httpPath":"/onboarding/v0/depsyncs/{id}/"}],"content":{"contentType":"group","meta":{"name":"7_DEP Sync Request"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DEP Sync Request","showPageActions":true},{"nodeType":"markdoc","content":"APIs to create and access DEP sync request information. Use DEP sync to sync the information from your Apple Business Manager account to the Esper console."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/onboarding/v0/depsyncs/","summary":"List all DEP sync requests for the tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/7_dep-sync-request/listdepsyncrequest","deprecated":false},{"title":"/onboarding/v0/depsyncs/","summary":"Create a DEP sync request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/7_dep-sync-request/createdepsyncrequest","deprecated":false},{"title":"/onboarding/v0/depsyncs/{id}/","summary":"Get a DEP sync request","prefix":{"name":"get","color":"get"},"badges":[],"link":"/7_dep-sync-request/getdepsyncrequest","deprecated":false}]}]}]}]}},{"type":"group","label":"ABM Provisioning","link":"/openapi/7_abm-provisioning","routeSlug":"/openapi/7_abm-provisioning","items":[{"label":"Create a ABM provisioning request by uploading file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/7_abm-provisioning/paths/~1v2~1seamless~1upload/post","routeSlug":"/openapi/7_abm-provisioning/paths/~1v2~1seamless~1upload/post","metadata":{"seo":{"title":"Create a ABM provisioning request by uploading file","description":"Create a ABM provisioning request by uploading file"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a ABM provisioning request by uploading file","isWebhook":false,"pointer":"/paths/~1v2~1seamless~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a ABM provisioning request by uploading file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_571"}},"schemaId":"schema_571","pointer":"/paths/~1v2~1seamless~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/seamless/upload","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_571"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/seamless/upload","href":"7_abm-provisioning/paths/~1v2~1seamless~1upload/post","summary":"Create a ABM provisioning request by uploading file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_571","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_571"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"ABM provisioning request successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_572"}},"schemaId":"schema_572"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1seamless~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_572","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_572"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/7_abm-provisioning/paths/~1v2~1seamless~1upload/post"}],"panels":[]}]},"httpPath":"/v2/seamless/upload"},{"label":"Create a ABM provisioning request using device serial number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/7_abm-provisioning/paths/~1v2~1seamless/post","routeSlug":"/openapi/7_abm-provisioning/paths/~1v2~1seamless/post","metadata":{"seo":{"title":"Create a ABM provisioning request using device serial number","description":"Create a ABM provisioning request using device serial number"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a ABM provisioning request using device serial number","isWebhook":false,"pointer":"/paths/~1v2~1seamless/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a ABM provisioning request using device serial number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeamlessRequestBody"}},"schemaId":"components/schemas/SeamlessRequestBody","pointer":"/paths/~1v2~1seamless/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/seamless","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SeamlessRequestBody"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/seamless","href":"7_abm-provisioning/paths/~1v2~1seamless/post","summary":"Create a ABM provisioning request using device serial number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/SeamlessRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SeamlessRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Seamless request successfully created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_573"}},"schemaId":"schema_573"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1seamless/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_573","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_573"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/7_abm-provisioning/paths/~1v2~1seamless/post"}],"panels":[]}]},"httpPath":"/v2/seamless"}],"content":{"contentType":"group","meta":{"name":"7_ABM Provisioning"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ABM Provisioning","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to perform ABM provisioning. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/20361103311761-Setting-Up-Apple-MDM-Management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ABM provisioning"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/seamless/upload","summary":"Create a ABM provisioning request by uploading file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/7_abm-provisioning/paths/~1v2~1seamless~1upload/post","deprecated":false},{"title":"/v2/seamless","summary":"Create a ABM provisioning request using device serial number","prefix":{"name":"post","color":"post"},"badges":[],"link":"/7_abm-provisioning/paths/~1v2~1seamless/post","deprecated":false}]}]}]}]}},{"type":"separator","label":"TENANT","content":null},{"type":"group","label":"APNs certificate","link":"/openapi/8_apns-certificate","routeSlug":"/openapi/8_apns-certificate","items":[{"label":"Get all APNs certificate meta data for the Tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_apns-certificate/listapnscerts","routeSlug":"/openapi/8_apns-certificate/listapnscerts","metadata":{"seo":{"title":"Get all APNs certificate meta data for the Tenant","description":"Returns all the APNs certificate meta information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAPNsCerts","name":"Get all APNs certificate meta data for the Tenant","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1apnscertificates~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all APNs certificate meta data for the Tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the APNs certificate meta information"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_461","description":"Number of records to return"},{"name":"offset","in":"query","schemaId":"schema_306","description":"Number of records to skip"},{"name":"state","in":"query","schemaId":"schema_574"}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tenant/v0/apnscertificates/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_461"},{"name":"offset","in":"query","schemaId":"schema_306"},{"name":"state","in":"query","schemaId":"schema_574"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/tenant/v0/apnscertificates/","href":"8_apns-certificate/listapnscerts","openApiOperationId":"listAPNsCerts","summary":"Get all APNs certificate meta data for the Tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"APNs certificate meta data list for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}},"schemaId":"schema_575"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_575","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_575"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_apns-certificate/listapnscerts"}],"panels":[]}]},"httpPath":"/tenant/v0/apnscertificates/"},{"label":"Get the CSR file to upload to the apple identity console","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_apns-certificate/getapnscsr","routeSlug":"/openapi/8_apns-certificate/getapnscsr","metadata":{"seo":{"title":"Get the CSR file to upload to the apple identity console","description":"Get the CSR file to upload to the apple identity console"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAPNsCSR","name":"Get the CSR file to upload to the apple identity console","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1apnscertificates~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the CSR file to upload to the apple identity console","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"schemaId":"components/schemas/PipelineRun_POST","pointer":"/paths/~1tenant~1v0~1apnscertificates~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tenant/v0/apnscertificates/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"responseCodes":["200","400","401","500"],"pointer":"/tenant/v0/apnscertificates/","href":"8_apns-certificate/getapnscsr","openApiOperationId":"getAPNsCSR","summary":"Get the CSR file to upload to the apple identity console"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/PipelineRun_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created","mediaType":"application/x-plist","mediaTypes":["application/x-plist"],"mediaTypeContent":{"application/x-plist":{"schemaId":"schema_576"}},"schemaId":"schema_576"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_576","mediaTypes":["application/x-plist"],"mediaTypeContent":{"application/x-plist":{"schemaId":"schema_576"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_apns-certificate/getapnscsr"}],"panels":[]}]},"httpPath":"/tenant/v0/apnscertificates/"},{"label":"Get APNs certificate meta information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_apns-certificate/getapnscert","routeSlug":"/openapi/8_apns-certificate/getapnscert","metadata":{"seo":{"title":"Get APNs certificate meta information","description":"Get APNs certificate meta information"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAPNsCert","name":"Get APNs certificate meta information","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get APNs certificate meta information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the APNs certificate meta object","required":true}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tenant/v0/apnscertificates/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/tenant/v0/apnscertificates/{id}/","href":"8_apns-certificate/getapnscert","openApiOperationId":"getAPNsCert","summary":"Get APNs certificate meta information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"APNs certificate meta information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}},"schemaId":"schema_577"},{"code":"401","description":"Authorization information is missing or invalid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_apns-certificate/getapnscert"}],"panels":[]}]},"httpPath":"/tenant/v0/apnscertificates/{id}/"},{"label":"Upload APNs certificate","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_apns-certificate/uploadapnscert","routeSlug":"/openapi/8_apns-certificate/uploadapnscert","metadata":{"seo":{"title":"Upload APNs certificate","description":"Upload the signed APNs certificate obtained from the apple identity console."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAPNsCert","name":"Upload APNs certificate","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload APNs certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload the signed APNs certificate obtained from the apple identity console."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the APNs certificate meta object","required":true}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/APNSCert_PUT"}},"schemaId":"components/schemas/APNSCert_PUT","pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tenant/v0/apnscertificates/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/APNSCert_PUT"}},"responseCodes":["200","400","401","404","500"],"pointer":"/tenant/v0/apnscertificates/{id}/","href":"8_apns-certificate/uploadapnscert","openApiOperationId":"uploadAPNsCert","summary":"Upload APNs certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/APNSCert_PUT","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/APNSCert_PUT"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Uploaded APNs certificate meta Information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}},"schemaId":"schema_577"},{"code":"400","description":"APNs certificate update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"APNs certificate update error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_577","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_577"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_apns-certificate/uploadapnscert"}],"panels":[]}]},"httpPath":"/tenant/v0/apnscertificates/{id}/"},{"label":"Delete a APNs certificate","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_apns-certificate/deleteapnscert","routeSlug":"/openapi/8_apns-certificate/deleteapnscert","metadata":{"seo":{"title":"Delete a APNs certificate","description":"Delete a APNs certificate"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAPNsCert","name":"Delete a APNs certificate","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a APNs certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_300","description":"ID of the APNs certificate meta object","required":true}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tenant/v0/apnscertificates/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404","500"],"pointer":"/tenant/v0/apnscertificates/{id}/","href":"8_apns-certificate/deleteapnscert","openApiOperationId":"deleteAPNsCert","summary":"Delete a APNs certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted APNs certificate","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_578"}},"schemaId":"schema_578"},{"code":"401","description":"APNs certificate delete error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1apnscertificates~1{id}~1/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_578","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_578"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_apns-certificate/deleteapnscert"}],"panels":[]}]},"httpPath":"/tenant/v0/apnscertificates/{id}/"}],"content":{"contentType":"group","meta":{"name":"8_APNs certificate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"APNs certificate","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs for managing APNS certificates. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/20361103311761-Setting-Up-Apple-MDM-Management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APNS certificates"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tenant/v0/apnscertificates/","summary":"Get all APNs certificate meta data for the Tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/8_apns-certificate/listapnscerts","deprecated":false},{"title":"/tenant/v0/apnscertificates/","summary":"Get the CSR file to upload to the apple identity console","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_apns-certificate/getapnscsr","deprecated":false},{"title":"/tenant/v0/apnscertificates/{id}/","summary":"Get APNs certificate meta information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/8_apns-certificate/getapnscert","deprecated":false},{"title":"/tenant/v0/apnscertificates/{id}/","summary":"Upload APNs certificate","prefix":{"name":"put","color":"put"},"badges":[],"link":"/8_apns-certificate/uploadapnscert","deprecated":false},{"title":"/tenant/v0/apnscertificates/{id}/","summary":"Delete a APNs certificate","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/8_apns-certificate/deleteapnscert","deprecated":false}]}]}]}]}},{"type":"group","label":"DEP Tokens","link":"/openapi/8_dep-tokens","routeSlug":"/openapi/8_dep-tokens","items":[{"label":"Generate the public key file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_dep-tokens/deptoken","routeSlug":"/openapi/8_dep-tokens/deptoken","metadata":{"seo":{"title":"Generate the public key file","description":"Generate the public key file which is uploaded to Apple Business Manager(ABM) console to generate the DEP token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DEPToken","name":"Generate the public key file","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1deptokens~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate the public key file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generate the public key file which is uploaded to Apple Business Manager(ABM) console to generate the DEP token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"schemaId":"components/schemas/PipelineRun_POST","pointer":"/paths/~1tenant~1v0~1deptokens~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tenant/v0/deptokens/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"responseCodes":["200","400","401","500"],"pointer":"/tenant/v0/deptokens/","href":"8_dep-tokens/deptoken","openApiOperationId":"DEPToken","summary":"Generate the public key file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/PipelineRun_POST","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PipelineRun_POST"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Public key generation for ABM","mediaType":"text/plain; charset=utf-8","mediaTypes":["text/plain; charset=utf-8"],"mediaTypeContent":{"text/plain; charset=utf-8":{"schemaId":"schema_579"}},"schemaId":"schema_579","headers":{"Content-Disposition":{"schema":{"type":"string","example":"attachment; filename=\"Esper_Public_Key.pem\""}}},"headerSchemaId":"schema_580"},{"code":"400","description":"Public key generation error - Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Public key generation error - Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Public key generation error - Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1deptokens~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_579","mediaTypes":["text/plain; charset=utf-8"],"mediaTypeContent":{"text/plain; charset=utf-8":{"schemaId":"schema_579"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_dep-tokens/deptoken"}],"panels":[]}]},"httpPath":"/tenant/v0/deptokens/"},{"label":"Get all DEP tokens","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_dep-tokens/listdeptokens","routeSlug":"/openapi/8_dep-tokens/listdeptokens","metadata":{"seo":{"title":"Get all DEP tokens","description":"Get the list of all DEP tokens available in the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListDEPTokens","name":"Get all DEP tokens","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1deptokens~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all DEP tokens","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of all DEP tokens available in the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"state","in":"query","schemaId":"schema_574"}],"pointer":"/paths/~1tenant~1v0~1deptokens~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tenant/v0/deptokens/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"state","in":"query","schemaId":"schema_574"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/tenant/v0/deptokens/","href":"8_dep-tokens/listdeptokens","openApiOperationId":"ListDEPTokens","summary":"Get all DEP tokens"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Lists all dep tokens for a tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_581"}},"schemaId":"schema_581"},{"code":"401","description":"Get DEP tokens error - Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Get DEP tokens error - Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1deptokens~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_581","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_581"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_dep-tokens/listdeptokens"}],"panels":[]}]},"httpPath":"/tenant/v0/deptokens/"},{"label":"Get dep token by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_dep-tokens/deptokenbasedonid","routeSlug":"/openapi/8_dep-tokens/deptokenbasedonid","metadata":{"seo":{"title":"Get dep token by id","description":"Retrive information of a DEP token by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DEPTokenBasedOnID","name":"Get dep token by id","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1deptokens~1{id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dep token by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrive information of a DEP token by ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_582","description":"ID of the token object","required":true}],"pointer":"/paths/~1tenant~1v0~1deptokens~1{id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tenant/v0/deptokens/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_582"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/tenant/v0/deptokens/{id}/","href":"8_dep-tokens/deptokenbasedonid","openApiOperationId":"DEPTokenBasedOnID","summary":"Get dep token by id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Get DEP token by id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_583"}},"schemaId":"schema_583"},{"code":"401","description":"Get DEP token by id error - Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Get DEP token by id error - Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1deptokens~1{id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_583","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_583"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_dep-tokens/deptokenbasedonid"}],"panels":[]}]},"httpPath":"/tenant/v0/deptokens/{id}/"},{"label":"Upload dep token to a tenant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_dep-tokens/deptokenupload","routeSlug":"/openapi/8_dep-tokens/deptokenupload","metadata":{"seo":{"title":"Upload dep token to a tenant","description":"Upload dep token for a public key for a tenant based on ID of DEP public key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DEPTokenUpload","name":"Upload dep token to a tenant","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1deptokens~1{id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload dep token to a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload dep token for a public key for a tenant based on ID of DEP public key"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_582","description":"ID of the token object","required":true}],"pointer":"/paths/~1tenant~1v0~1deptokens~1{id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_584"}},"schemaId":"schema_584","pointer":"/paths/~1tenant~1v0~1deptokens~1{id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/tenant/v0/deptokens/{id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_582"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_584"}},"responseCodes":["200","400","401","404","500"],"pointer":"/tenant/v0/deptokens/{id}/","href":"8_dep-tokens/deptokenupload","openApiOperationId":"DEPTokenUpload","summary":"Upload dep token to a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_584","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_584"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Upload dep token for a public key by id","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_583"}},"schemaId":"schema_583"},{"code":"400","description":"Upload DEP token by id error - Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Upload DEP token by id error - Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Upload DEP token by id error - Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1deptokens~1{id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_583","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_583"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_dep-tokens/deptokenupload"}],"panels":[]}]},"httpPath":"/tenant/v0/deptokens/{id}/"}],"content":{"contentType":"group","meta":{"name":"8_DEP Tokens"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DEP Tokens","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to create and access DEP tokens. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/20361103311761-Setting-Up-Apple-MDM-Management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEP tokens"},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tenant/v0/deptokens/","summary":"Generate the public key file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_dep-tokens/deptoken","deprecated":false},{"title":"/tenant/v0/deptokens/","summary":"Get all DEP tokens","prefix":{"name":"get","color":"get"},"badges":[],"link":"/8_dep-tokens/listdeptokens","deprecated":false},{"title":"/tenant/v0/deptokens/{id}/","summary":"Get dep token by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/8_dep-tokens/deptokenbasedonid","deprecated":false},{"title":"/tenant/v0/deptokens/{id}/","summary":"Upload dep token to a tenant","prefix":{"name":"put","color":"put"},"badges":[],"link":"/8_dep-tokens/deptokenupload","deprecated":false}]}]}]}]}},{"type":"group","label":"VPP Token Management","link":"/openapi/8_vpp-token-management","routeSlug":"/openapi/8_vpp-token-management","items":[{"label":"Get all VPP tokens for the tenant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/get","routeSlug":"/openapi/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/get","metadata":{"seo":{"title":"Get all VPP tokens for the tenant","description":"Returns all the VPP tokens for the tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get all VPP tokens for the tenant","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1vpptokens~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all VPP tokens for the tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all the VPP tokens for the tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tenant/v0/vpptokens/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/tenant/v0/vpptokens/","href":"8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/get","summary":"Get all VPP tokens for the tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"VPP tokens for the Tenant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}},"schemaId":"schema_585"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1vpptokens~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_585","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_585"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/get"}],"panels":[]}]},"httpPath":"/tenant/v0/vpptokens/"},{"label":"Store a VPP token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/post","routeSlug":"/openapi/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/post","metadata":{"seo":{"title":"Store a VPP token","description":"Uploads a VPP token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Store a VPP token","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1vpptokens~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Store a VPP token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Uploads a VPP token"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_586"}},"schemaId":"schema_586","pointer":"/paths/~1tenant~1v0~1vpptokens~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/tenant/v0/vpptokens/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_586"}},"responseCodes":["201","400","401","500"],"pointer":"/tenant/v0/vpptokens/","href":"8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/post","summary":"Store a VPP token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_586","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_586"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_587"}},"schemaId":"schema_587"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1vpptokens~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_587","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_587"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/post"}],"panels":[]}]},"httpPath":"/tenant/v0/vpptokens/"},{"label":"Delete VPP Token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1{id}/delete","routeSlug":"/openapi/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1{id}/delete","metadata":{"seo":{"title":"Delete VPP Token","description":"API to delete vpp token for a tenant"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete VPP Token","isWebhook":false,"pointer":"/paths/~1tenant~1v0~1vpptokens~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete VPP Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API to delete vpp token for a tenant"},{"nodeType":"security","requirements":[{"schemes":[{"name":"apiKey","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_302","required":true}],"pointer":"/paths/~1tenant~1v0~1vpptokens~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/tenant/v0/vpptokens/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_302"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"apiKey","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","404","500"],"pointer":"/tenant/v0/vpptokens/{id}","href":"8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1{id}/delete","summary":"Delete VPP Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}},"schemaId":"schema_588"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Resource Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1tenant~1v0~1vpptokens~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204","schemaId":"schema_588","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_588"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1{id}/delete"}],"panels":[]}]},"httpPath":"/tenant/v0/vpptokens/{id}"}],"content":{"contentType":"group","meta":{"name":"8_VPP Token Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VPP Token Management","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs to create, access, and delete VPP tokens. Learn more about "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/20361103311761-Setting-Up-Apple-MDM-Management"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VPP tokens"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tenant/v0/vpptokens/","summary":"Get all VPP tokens for the tenant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/get","deprecated":false},{"title":"/tenant/v0/vpptokens/","summary":"Store a VPP token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1/post","deprecated":false},{"title":"/tenant/v0/vpptokens/{id}","summary":"Delete VPP Token","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/8_vpp-token-management/paths/~1tenant~1v0~1vpptokens~1{id}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"Google Enterprise","link":"/openapi/8_google-enterprise","routeSlug":"/openapi/8_google-enterprise","items":[{"label":"Generate sign-up URL","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_google-enterprise/paths/~1v2~1emm~1enrollment~1begin~1/post","routeSlug":"/openapi/8_google-enterprise/paths/~1v2~1emm~1enrollment~1begin~1/post","metadata":{"seo":{"title":"Generate sign-up URL","description":"Generate sign-up URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Generate sign-up URL","isWebhook":false,"pointer":"/paths/~1v2~1emm~1enrollment~1begin~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate sign-up URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_300","description":"Bearer token for authorization","required":true}],"pointer":"/paths/~1v2~1emm~1enrollment~1begin~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeginGoogleEMMEnrollmentRequest"}},"schemaId":"components/schemas/BeginGoogleEMMEnrollmentRequest","pointer":"/paths/~1v2~1emm~1enrollment~1begin~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/emm/enrollment/begin/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_300"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/BeginGoogleEMMEnrollmentRequest"}},"responseCodes":["201","400","401","409","500"],"pointer":"/v2/emm/enrollment/begin/","href":"8_google-enterprise/paths/~1v2~1emm~1enrollment~1begin~1/post","summary":"Generate sign-up URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/BeginGoogleEMMEnrollmentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BeginGoogleEMMEnrollmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successfully generated sign-up URL","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeginGoogleEMMEnrollmentResponse"}},"schemaId":"components/schemas/BeginGoogleEMMEnrollmentResponse"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"409","description":"Conflict: Google Enterprise already exists and is enrolled to Google EMM","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}},"schemaId":"components/schemas/Error_409_Conflict"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1emm~1enrollment~1begin~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/BeginGoogleEMMEnrollmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BeginGoogleEMMEnrollmentResponse"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"409","schemaId":"components/schemas/Error_409_Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_google-enterprise/paths/~1v2~1emm~1enrollment~1begin~1/post"}],"panels":[]}]},"httpPath":"/v2/emm/enrollment/begin/"},{"label":"Return the enrollment status of the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_google-enterprise/paths/~1v2~1emm~1details~1/get","routeSlug":"/openapi/8_google-enterprise/paths/~1v2~1emm~1details~1/get","metadata":{"seo":{"title":"Return the enrollment status of the Enterprise","description":"Return the enrollment status of the Enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Return the enrollment status of the Enterprise","isWebhook":false,"pointer":"/paths/~1v2~1emm~1details~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return the enrollment status of the Enterprise","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_300","description":"Bearer token for authorization","required":true}],"pointer":"/paths/~1v2~1emm~1details~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/emm/details/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_300"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","500"],"pointer":"/v2/emm/details/","href":"8_google-enterprise/paths/~1v2~1emm~1details~1/get","summary":"Return the enrollment status of the Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved enrollment status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}},"schemaId":"schema_589"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1emm~1details~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_589","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_589"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_google-enterprise/paths/~1v2~1emm~1details~1/get"}],"panels":[]}]},"httpPath":"/v2/emm/details/"},{"label":"Creates a new Google Enterprise with the provided details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_google-enterprise/paths/~1v2~1emm~1details~1/post","routeSlug":"/openapi/8_google-enterprise/paths/~1v2~1emm~1details~1/post","metadata":{"seo":{"title":"Creates a new Google Enterprise with the provided details","description":"Creates a new Google Enterprise with the provided details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Creates a new Google Enterprise with the provided details","isWebhook":false,"pointer":"/paths/~1v2~1emm~1details~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new Google Enterprise with the provided details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_300","description":"Bearer token for authorization","required":true}],"pointer":"/paths/~1v2~1emm~1details~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleEnterpriseDetails"}},"schemaId":"components/schemas/GoogleEnterpriseDetails","pointer":"/paths/~1v2~1emm~1details~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/emm/details/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_300"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleEnterpriseDetails"}},"responseCodes":["201","400","401","409","500"],"pointer":"/v2/emm/details/","href":"8_google-enterprise/paths/~1v2~1emm~1details~1/post","summary":"Creates a new Google Enterprise with the provided details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleEnterpriseDetails","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleEnterpriseDetails"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEnterpriseDetails"}},"schemaId":"components/schemas/GoogleEnterpriseDetails"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"409","description":"Conflict: Google Enterprise already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}},"schemaId":"components/schemas/Error_409_Conflict"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1emm~1details~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/GoogleEnterpriseDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEnterpriseDetails"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"409","schemaId":"components/schemas/Error_409_Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_google-enterprise/paths/~1v2~1emm~1details~1/post"}],"panels":[]}]},"httpPath":"/v2/emm/details/"},{"label":"Create a Google Web Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_google-enterprise/paths/~1v2~1emm~1web-token~1/post","routeSlug":"/openapi/8_google-enterprise/paths/~1v2~1emm~1web-token~1/post","metadata":{"seo":{"title":"Create a Google Web Token","description":"Create a Google Web Token"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a Google Web Token","isWebhook":false,"pointer":"/paths/~1v2~1emm~1web-token~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Google Web Token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_300","description":"Bearer token for authorization","required":true}],"pointer":"/paths/~1v2~1emm~1web-token~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebTokenRequest"}},"schemaId":"components/schemas/CreateWebTokenRequest","pointer":"/paths/~1v2~1emm~1web-token~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/emm/web-token/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_300"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateWebTokenRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/v2/emm/web-token/","href":"8_google-enterprise/paths/~1v2~1emm~1web-token~1/post","summary":"Create a Google Web Token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/CreateWebTokenRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateWebTokenRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebTokenResponse"}},"schemaId":"components/schemas/CreateWebTokenResponse"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1emm~1web-token~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateWebTokenResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateWebTokenResponse"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_google-enterprise/paths/~1v2~1emm~1web-token~1/post"}],"panels":[]}]},"httpPath":"/v2/emm/web-token/"},{"label":"Complete EMM enrollment for a Google Enterprise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_google-enterprise/paths/~1v2~1emm~1enrollment~1complete~1/post","routeSlug":"/openapi/8_google-enterprise/paths/~1v2~1emm~1enrollment~1complete~1/post","metadata":{"seo":{"title":"Complete EMM enrollment for a Google Enterprise","description":"Complete EMM enrollment for a Google Enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Complete EMM enrollment for a Google Enterprise","isWebhook":false,"pointer":"/paths/~1v2~1emm~1enrollment~1complete~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete EMM enrollment for a Google Enterprise","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_300","description":"Bearer token for authorization","required":true}],"pointer":"/paths/~1v2~1emm~1enrollment~1complete~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_590"}},"schemaId":"schema_590","pointer":"/paths/~1v2~1emm~1enrollment~1complete~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/emm/enrollment/complete/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_300"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_590"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v2/emm/enrollment/complete/","href":"8_google-enterprise/paths/~1v2~1emm~1enrollment~1complete~1/post","summary":"Complete EMM enrollment for a Google Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"schema_590","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_590"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully completed EMM enrollment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEnterpriseDetails"}},"schemaId":"components/schemas/GoogleEnterpriseDetails"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1emm~1enrollment~1complete~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GoogleEnterpriseDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleEnterpriseDetails"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_google-enterprise/paths/~1v2~1emm~1enrollment~1complete~1/post"}],"panels":[]}]},"httpPath":"/v2/emm/enrollment/complete/"},{"label":"Return the Google Service Account of the Enterprise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_google-enterprise/paths/~1v2~1emm~1accounts~1/get","routeSlug":"/openapi/8_google-enterprise/paths/~1v2~1emm~1accounts~1/get","metadata":{"seo":{"title":"Return the Google Service Account of the Enterprise","description":"Return the Google Service Account of the Enterprise"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Return the Google Service Account of the Enterprise","isWebhook":false,"pointer":"/paths/~1v2~1emm~1accounts~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Return the Google Service Account of the Enterprise","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_300","description":"Bearer token for authorization","required":true}],"pointer":"/paths/~1v2~1emm~1accounts~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/emm/accounts/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_300"}],"cookie":[]},"security":[],"responseCodes":["200","400","401","500"],"pointer":"/v2/emm/accounts/","href":"8_google-enterprise/paths/~1v2~1emm~1accounts~1/get","summary":"Return the Google Service Account of the Enterprise"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved Google Service Account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}},"schemaId":"schema_591"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1emm~1accounts~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_591","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_591"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_google-enterprise/paths/~1v2~1emm~1accounts~1/get"}],"panels":[]}]},"httpPath":"/v2/emm/accounts/"},{"label":"Creates a new Google Service Account with the provided details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/8_google-enterprise/paths/~1v2~1emm~1accounts~1/post","routeSlug":"/openapi/8_google-enterprise/paths/~1v2~1emm~1accounts~1/post","metadata":{"seo":{"title":"Creates a new Google Service Account with the provided details","description":"Creates a new Google Service Account with the provided details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Creates a new Google Service Account with the provided details","isWebhook":false,"pointer":"/paths/~1v2~1emm~1accounts~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new Google Service Account with the provided details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Authorization","in":"header","schemaId":"schema_300","description":"Bearer token for authorization","required":true}],"pointer":"/paths/~1v2~1emm~1accounts~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleServiceAccountDetails"}},"schemaId":"components/schemas/GoogleServiceAccountDetails","pointer":"/paths/~1v2~1emm~1accounts~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/emm/accounts/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Authorization","in":"header","required":true,"schemaId":"schema_300"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/GoogleServiceAccountDetails"}},"responseCodes":["201","400","401","409","500"],"pointer":"/v2/emm/accounts/","href":"8_google-enterprise/paths/~1v2~1emm~1accounts~1/post","summary":"Creates a new Google Service Account with the provided details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/GoogleServiceAccountDetails","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GoogleServiceAccountDetails"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful Response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleServiceAccountDetails"}},"schemaId":"components/schemas/GoogleServiceAccountDetails"},{"code":"400","description":"Invalid input","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"409","description":"Conflict: Google Service Account already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}},"schemaId":"components/schemas/Error_409_Conflict"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v2~1emm~1accounts~1/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/GoogleServiceAccountDetails","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GoogleServiceAccountDetails"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"409","schemaId":"components/schemas/Error_409_Conflict","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_409_Conflict"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/8_google-enterprise/paths/~1v2~1emm~1accounts~1/post"}],"panels":[]}]},"httpPath":"/v2/emm/accounts/"}],"content":{"contentType":"group","meta":{"name":"8_Google Enterprise"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Google Enterprise","showPageActions":true},{"nodeType":"markdoc","content":"APIs to enroll the enterprise in Google EMM."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/emm/enrollment/begin/","summary":"Generate sign-up URL","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_google-enterprise/paths/~1v2~1emm~1enrollment~1begin~1/post","deprecated":false},{"title":"/v2/emm/details/","summary":"Return the enrollment status of the Enterprise","prefix":{"name":"get","color":"get"},"badges":[],"link":"/8_google-enterprise/paths/~1v2~1emm~1details~1/get","deprecated":false},{"title":"/v2/emm/details/","summary":"Creates a new Google Enterprise with the provided details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_google-enterprise/paths/~1v2~1emm~1details~1/post","deprecated":false},{"title":"/v2/emm/web-token/","summary":"Create a Google Web Token","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_google-enterprise/paths/~1v2~1emm~1web-token~1/post","deprecated":false},{"title":"/v2/emm/enrollment/complete/","summary":"Complete EMM enrollment for a Google Enterprise","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_google-enterprise/paths/~1v2~1emm~1enrollment~1complete~1/post","deprecated":false},{"title":"/v2/emm/accounts/","summary":"Return the Google Service Account of the Enterprise","prefix":{"name":"get","color":"get"},"badges":[],"link":"/8_google-enterprise/paths/~1v2~1emm~1accounts~1/get","deprecated":false},{"title":"/v2/emm/accounts/","summary":"Creates a new Google Service Account with the provided details","prefix":{"name":"post","color":"post"},"badges":[],"link":"/8_google-enterprise/paths/~1v2~1emm~1accounts~1/post","deprecated":false}]}]}]}]}},{"type":"separator","label":"FOUNDATION","content":null},{"type":"group","label":"FoundryBuilds","link":"/openapi/9_foundrybuilds","routeSlug":"/openapi/9_foundrybuilds","items":[{"label":"Get Foundry builds","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/9_foundrybuilds/getfoundrybuilds","routeSlug":"/openapi/9_foundrybuilds/getfoundrybuilds","metadata":{"seo":{"title":"Get Foundry builds","description":"Returns a list of all specified builds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFoundryBuilds","name":"Get Foundry builds","isWebhook":false,"pointer":"/paths/~1v1~1foundry~1builds~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Foundry builds","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all specified builds."},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"foundation_major_number","in":"query","schemaId":"schema_300","description":"Filter by Esper Foundation Major Number, Foundation Numbers are integers starting at 1."},{"name":"build_arch","in":"query","schemaId":"schema_300","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by build architecture name, build architectures {arm, arm64, x86_64, x86}"},"children":[]}]}]}]},{"name":"android_major_version","in":"query","schemaId":"schema_302","description":"Filter by Android Major Version, Android Major Versions are integers starting at 1 and going to Current Android Release"},{"name":"device_model_id","in":"query","schemaId":"schema_299","description":"Device model id"},{"name":"approved","in":"query","schemaId":"schema_301","description":"Filter builds which have been approved for OTA update"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"ordering","in":"query","schemaId":"schema_300"},{"name":"locked","in":"query","schemaId":"schema_301","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter the locked builds. To be used with build_fingerprint_hash and device_model_id"},"children":[]}]}]}]},{"name":"build_fingerprint_hash","in":"query","schemaId":"schema_300","description":"hash of the build fingerprint of the existing build"}],"pointer":"/paths/~1v1~1foundry~1builds~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/foundry/builds/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"foundation_major_number","in":"query","schemaId":"schema_300"},{"name":"build_arch","in":"query","schemaId":"schema_300"},{"name":"android_major_version","in":"query","schemaId":"schema_302"},{"name":"device_model_id","in":"query","schemaId":"schema_299"},{"name":"approved","in":"query","schemaId":"schema_301"},{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"},{"name":"ordering","in":"query","schemaId":"schema_300"},{"name":"locked","in":"query","schemaId":"schema_301"},{"name":"build_fingerprint_hash","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v1/foundry/builds/","href":"9_foundrybuilds/getfoundrybuilds","openApiOperationId":"getFoundryBuilds","summary":"Get Foundry builds"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Foundry builds","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_592"}},"schemaId":"schema_592"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v1~1foundry~1builds~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_592","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_592"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/9_foundrybuilds/getfoundrybuilds"}],"panels":[]}]},"httpPath":"/v1/foundry/builds/"},{"label":"Get Foundry Build","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/9_foundrybuilds/paths/~1v1~1foundry~1builds~1{build_id}~1/get","routeSlug":"/openapi/9_foundrybuilds/paths/~1v1~1foundry~1builds~1{build_id}~1/get","metadata":{"seo":{"title":"Get Foundry Build","description":"Get a Foundry Build by unique ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Foundry Build","isWebhook":false,"pointer":"/paths/~1v1~1foundry~1builds~1{build_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Foundry Build","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a Foundry Build by unique ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"build_id","in":"path","schemaId":"schema_300","description":"A build UUID specifying the Foundry Build","required":true}],"pointer":"/paths/~1v1~1foundry~1builds~1{build_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/foundry/builds/{build_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"build_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","500"],"pointer":"/v1/foundry/builds/{build_id}/","href":"9_foundrybuilds/paths/~1v1~1foundry~1builds~1{build_id}~1/get","summary":"Get Foundry Build"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Foundry build","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}},"schemaId":"schema_593"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Build not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v1~1foundry~1builds~1{build_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_593","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_593"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/9_foundrybuilds/paths/~1v1~1foundry~1builds~1{build_id}~1/get"}],"panels":[]}]},"httpPath":"/v1/foundry/builds/{build_id}/"},{"label":"Update Foundry build","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/9_foundrybuilds/updatefoundrybuild","routeSlug":"/openapi/9_foundrybuilds/updatefoundrybuild","metadata":{"seo":{"title":"Update Foundry build","description":"Update a Foundry build based on given parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFoundryBuild","name":"Update Foundry build","isWebhook":false,"pointer":"/paths/~1v1~1foundry~1builds~1{build_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Foundry build","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Foundry build based on given parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"build_id","in":"path","schemaId":"schema_300","description":"A build UUID specifying the Foundry Build","required":true}],"pointer":"/paths/~1v1~1foundry~1builds~1{build_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Foundry_Build_PUT_Request_V1"}},"schemaId":"components/schemas/Foundry_Build_PUT_Request_V1","pointer":"/paths/~1v1~1foundry~1builds~1{build_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/foundry/builds/{build_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"build_id","in":"path","required":true,"schemaId":"schema_300"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Foundry_Build_PUT_Request_V1"}},"responseCodes":["200","400","401","404"],"pointer":"/v1/foundry/builds/{build_id}/","href":"9_foundrybuilds/updatefoundrybuild","openApiOperationId":"updateFoundryBuild","summary":"Update Foundry build"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Foundry_Build_PUT_Request_V1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Foundry_Build_PUT_Request_V1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"404","description":"Builds not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"}],"pointer":"/paths/~1v1~1foundry~1builds~1{build_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_594"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/9_foundrybuilds/updatefoundrybuild"}],"panels":[]}]},"httpPath":"/v1/foundry/builds/{build_id}/"}],"content":{"contentType":"group","meta":{"name":"9_FoundryBuilds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FoundryBuilds","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/foundry/builds/","summary":"Get Foundry builds","prefix":{"name":"get","color":"get"},"badges":[],"link":"/9_foundrybuilds/getfoundrybuilds","deprecated":false},{"title":"/v1/foundry/builds/{build_id}/","summary":"Get Foundry Build","prefix":{"name":"get","color":"get"},"badges":[],"link":"/9_foundrybuilds/paths/~1v1~1foundry~1builds~1{build_id}~1/get","deprecated":false},{"title":"/v1/foundry/builds/{build_id}/","summary":"Update Foundry build","prefix":{"name":"put","color":"put"},"badges":[],"link":"/9_foundrybuilds/updatefoundrybuild","deprecated":false}]}]}]}]}},{"type":"group","label":"FoundryDeviceModels","link":"/openapi/9_foundrydevicemodels","routeSlug":"/openapi/9_foundrydevicemodels","items":[{"label":"Get device models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1/get","routeSlug":"/openapi/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1/get","metadata":{"seo":{"title":"Get device models","description":"Get a list of device models"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get device models","isWebhook":false,"pointer":"/paths/~1v1~1foundry~1device-models~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get device models","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of device models"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_300"},{"name":"offset","in":"query","schemaId":"schema_300"},{"name":"manufacturer","in":"query","schemaId":"schema_300"},{"name":"model","in":"query","schemaId":"schema_300"},{"name":"profile_name","in":"query","schemaId":"schema_300"},{"name":"profile_variant","in":"query","schemaId":"schema_300"},{"name":"update_compatible_android_api_level_begin","in":"query","schemaId":"schema_300"},{"name":"update_compatible_android_api_level_end","in":"query","schemaId":"schema_300"}],"pointer":"/paths/~1v1~1foundry~1device-models~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/foundry/device-models/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_300"},{"name":"offset","in":"query","schemaId":"schema_300"},{"name":"manufacturer","in":"query","schemaId":"schema_300"},{"name":"model","in":"query","schemaId":"schema_300"},{"name":"profile_name","in":"query","schemaId":"schema_300"},{"name":"profile_variant","in":"query","schemaId":"schema_300"},{"name":"update_compatible_android_api_level_begin","in":"query","schemaId":"schema_300"},{"name":"update_compatible_android_api_level_end","in":"query","schemaId":"schema_300"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v1/foundry/device-models/","href":"9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1/get","summary":"Get device models"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of DeviceModels associated with the TenantId coming from the header","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_595"}},"schemaId":"schema_595"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v1~1foundry~1device-models~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_595","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_595"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1/get"}],"panels":[]}]},"httpPath":"/v1/foundry/device-models/"},{"label":"Update Tenant Device Model","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put","routeSlug":"/openapi/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put","metadata":{"seo":{"title":"Update Tenant Device Model","description":"Update a Tenant Device Model based on given parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update Tenant Device Model","isWebhook":false,"pointer":"/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Tenant Device Model","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a Tenant Device Model based on given parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"device_model_id","in":"path","schemaId":"schema_299","description":"An UUID specifying the Device Model","required":true}],"pointer":"/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Device_Model_PUT_Request_V1"}},"schemaId":"components/schemas/Device_Model_PUT_Request_V1","pointer":"/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/foundry/device-models/{device_model_id}/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"device_model_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Device_Model_PUT_Request_V1"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/foundry/device-models/{device_model_id}/","href":"9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put","summary":"Update Tenant Device Model"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Device_Model_PUT_Request_V1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Device_Model_PUT_Request_V1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_594"}},"schemaId":"schema_594"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"locked_build_id not approved"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}},"schemaId":"components/schemas/Error_403_Forbidden"},{"code":"404","description":"DeviceModel not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}},"schemaId":"components/schemas/Error_404_Not_Found"}],"pointer":"/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_594","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_594"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"403","schemaId":"components/schemas/Error_403_Forbidden","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_403_Forbidden"}}},{"code":"404","schemaId":"components/schemas/Error_404_Not_Found","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_404_Not_Found"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put"}],"panels":[]}]},"httpPath":"/v1/foundry/device-models/{device_model_id}/"}],"content":{"contentType":"group","meta":{"name":"9_FoundryDeviceModels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FoundryDeviceModels","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/foundry/device-models/","summary":"Get device models","prefix":{"name":"get","color":"get"},"badges":[],"link":"/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1/get","deprecated":false},{"title":"/v1/foundry/device-models/{device_model_id}/","summary":"Update Tenant Device Model","prefix":{"name":"put","color":"put"},"badges":[],"link":"/9_foundrydevicemodels/paths/~1v1~1foundry~1device-models~1{device_model_id}~1/put","deprecated":false}]}]}]}]}},{"type":"group","label":"FoundryEvents","link":"/openapi/9_foundryevents","routeSlug":"/openapi/9_foundryevents","items":[{"label":"Get Foundry events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/9_foundryevents/paths/~1v1~1foundry~1events~1/get","routeSlug":"/openapi/9_foundryevents/paths/~1v1~1foundry~1events~1/get","metadata":{"seo":{"title":"Get Foundry events","description":"Get a list of Foundry events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get Foundry events","isWebhook":false,"pointer":"/paths/~1v1~1foundry~1events~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Foundry events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a list of Foundry events"},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"pointer":"/paths/~1v1~1foundry~1events~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/foundry/events/","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_302"},{"name":"offset","in":"query","schemaId":"schema_302"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/v1/foundry/events/","href":"9_foundryevents/paths/~1v1~1foundry~1events~1/get","summary":"Get Foundry events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Foundry events in reverse chronological order","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}},"schemaId":"schema_596"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}},"schemaId":"components/schemas/Error_400_Bad_Data"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}},"schemaId":"components/schemas/Error_401_Unauthorized"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}},"schemaId":"components/schemas/Error_500_Internal_Server_Error"}],"pointer":"/paths/~1v1~1foundry~1events~1/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_596","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_596"}}},{"code":"400","schemaId":"components/schemas/Error_400_Bad_Data","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_400_Bad_Data"}}},{"code":"401","schemaId":"components/schemas/Error_401_Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_401_Unauthorized"}}},{"code":"500","schemaId":"components/schemas/Error_500_Internal_Server_Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error_500_Internal_Server_Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/9_foundryevents/paths/~1v1~1foundry~1events~1/get"}],"panels":[]}]},"httpPath":"/v1/foundry/events/"}],"content":{"contentType":"group","meta":{"name":"9_FoundryEvents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"FoundryEvents","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/foundry/events/","summary":"Get Foundry events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/9_foundryevents/paths/~1v1~1foundry~1events~1/get","deprecated":false}]}]}]}]}},{"type":"separator","label":"REPORTS","content":null},{"type":"group","label":"Reports API","link":"/openapi/10_reports-api","routeSlug":"/openapi/10_reports-api","items":[{"label":"Get report types","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/10_reports-api/getreporttypes","routeSlug":"/openapi/10_reports-api/getreporttypes","metadata":{"seo":{"title":"Get report types","description":"Get report types"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportTypes","name":"Get report types","isWebhook":false,"pointer":"/paths/~1report~1v0~1report-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get report types","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get report types"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/report/v0/report-types","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/report/v0/report-types","href":"10_reports-api/getreporttypes","openApiOperationId":"getReportTypes","summary":"Get report types"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report types","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetReportTypesResponse"}},"schemaId":"components/schemas/GetReportTypesResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"}],"pointer":"/paths/~1report~1v0~1report-types/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetReportTypesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetReportTypesResponse"}}},{"code":"400","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/10_reports-api/getreporttypes"}],"panels":[]}]},"httpPath":"/report/v0/report-types"},{"label":"Create Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/10_reports-api/createreportstatus","routeSlug":"/openapi/10_reports-api/createreportstatus","metadata":{"seo":{"title":"Create Report","description":"This API will return a report ID. Use this ID to call the \"Get Report Status\" API to check the report generation status and retrieve the results. Learn more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createReportStatus","name":"Create Report","isWebhook":false,"pointer":"/paths/~1report~1v0~1reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API will return a report ID. Use this ID to call the \"Get Report Status\" API to check the report generation status and retrieve the results. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/27379366650257"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Report"}},"schemaId":"components/schemas/Report","pointer":"/paths/~1report~1v0~1reports/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/report/v0/reports","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Report"}},"responseCodes":["200","400","401","500"],"pointer":"/report/v0/reports","href":"10_reports-api/createreportstatus","openApiOperationId":"createReportStatus","summary":"Create Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"schemaId":"components/schemas/Report","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Report"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Create Report","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateReportResponse"}},"schemaId":"components/schemas/CreateReportResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"}],"pointer":"/paths/~1report~1v0~1reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreateReportResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreateReportResponse"}}},{"code":"400","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/10_reports-api/createreportstatus"}],"panels":[]}]},"httpPath":"/report/v0/reports"},{"label":"Get report status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/10_reports-api/getreportstatus","routeSlug":"/openapi/10_reports-api/getreportstatus","metadata":{"seo":{"title":"Get report status","description":"Call this API with report ID generated from \"Create Report\" API to check the report generation status and retrieve the results. Learn more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportStatus","name":"Get report status","isWebhook":false,"pointer":"/paths/~1report~1v0~1reports~1{report_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get report status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call this API with report ID generated from \"Create Report\" API to check the report generation status and retrieve the results. "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/27379366650257"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn more"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_299","description":"Report ID","required":true}],"pointer":"/paths/~1report~1v0~1reports~1{report_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/report/v0/reports/{report_id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"schemaId":"schema_299"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/report/v0/reports/{report_id}","href":"10_reports-api/getreportstatus","openApiOperationId":"getReportStatus","summary":"Get report status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Report status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}},"schemaId":"schema_597"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}},"schemaId":"components/schemas/ReportsErrorResponse"}],"pointer":"/paths/~1report~1v0~1reports~1{report_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_597","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_597"}}},{"code":"400","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}},{"code":"401","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ReportsErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportsErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/10_reports-api/getreportstatus"}],"panels":[]}]},"httpPath":"/report/v0/reports/{report_id}"}],"content":{"contentType":"group","meta":{"name":"10_Reports API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports API","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs for managing reports."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Currently supports "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/27379366650257-App-Reports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App Reports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/report/v0/report-types","summary":"Get report types","prefix":{"name":"get","color":"get"},"badges":[],"link":"/10_reports-api/getreporttypes","deprecated":false},{"title":"/report/v0/reports","summary":"Create Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/10_reports-api/createreportstatus","deprecated":false},{"title":"/report/v0/reports/{report_id}","summary":"Get report status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/10_reports-api/getreportstatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ApplicationVersion":{"id":"components/schemas/ApplicationVersion","kind":"json-schema","title":"Version","data":{"title":"Version","type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"version_code":{"title":"Version code","maxLength":50,"minLength":1,"type":"string"},"build_number":{"title":"Build number","maxLength":100,"minLength":1,"type":"string","nullable":true},"hash_string":{"title":"Hash string","type":"string"},"min_sdk_version":{"title":"Min sdk version","maxLength":10,"minLength":1,"type":"string","nullable":true},"target_sdk_version":{"title":"Target sdk version","maxLength":10,"minLength":1,"type":"string","nullable":true},"download_url":{"title":"Url","type":"string","format":"url"},"icon_url":{"title":"Url for the icon","type":"string","format":"url"},"release_name":{"title":"Name of the release","type":"string"},"release_comments":{"title":"comments about the release","type":"string"}}}},"components/schemas/Application":{"id":"components/schemas/Application","kind":"json-schema","title":"Application","data":{"required":["application_name","enterprise","package_name"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"versions":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationVersion"}},"application_name":{"title":"Application name","maxLength":255,"minLength":1,"type":"string"},"package_name":{"title":"Package name","maxLength":255,"minLength":1,"type":"string"},"developer":{"title":"Developer","maxLength":255,"minLength":1,"type":"string","nullable":true},"category":{"title":"Category","maxLength":255,"minLength":1,"type":"string","nullable":true},"content_rating":{"title":"Content rating","type":"string","format":"decimal"},"compatibility":{"title":"Compatibility","minLength":1,"type":"string","nullable":true},"created_on":{"title":"Created on","type":"string","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","format":"date-time","readOnly":true},"is_active":{"title":"Is active","type":"boolean"},"is_hidden":{"title":"Is hidden","type":"boolean"},"enterprise":{"title":"Enterprise","type":"string","format":"url"}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","properties":{"errors":{"title":"Messages describing the error","type":"array","items":{"type":"string"}},"message":{"title":"Message describing the error","type":"string"},"status":{"title":"alias name","type":"integer"}}}},"components/schemas/AppPermission":{"id":"components/schemas/AppPermission","kind":"json-schema","title":"AppPermission","data":{"required":["enterprise","permission"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"permission":{"title":"Permission","maxLength":255,"minLength":1,"type":"string"},"grant_state":{"title":"Grant state","type":"string","enum":["Default","Denied","Granted"]},"created_on":{"title":"Created on","type":"string","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","format":"date-time","readOnly":true},"is_active":{"title":"Is active","type":"boolean"},"enterprise":{"title":"Enterprise","type":"string","format":"url"},"app_version":{"title":"App version","type":"string","format":"url"}}}},"components/schemas/AppVersion":{"id":"components/schemas/AppVersion","kind":"json-schema","title":"Application Version","data":{"title":"Application Version","required":["enterprise","permissions","version_code"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"installed_count":{"title":"Installed count","type":"integer","readOnly":true},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/AppPermission"}},"app_file":{"title":"App file","type":"string","format":"url","readOnly":true},"app_icon":{"title":"App icon","type":"string","format":"url","nullable":true,"readOnly":true},"version_code":{"title":"Version code","maxLength":50,"minLength":1,"type":"string"},"build_number":{"title":"Build number","maxLength":100,"minLength":1,"type":"string","nullable":true},"size_in_mb":{"title":"Size in mb","type":"number"},"hash_string":{"title":"Hash string","type":"string"},"release_name":{"title":"Release name","maxLength":255,"minLength":1,"type":"string","nullable":true},"release_comments":{"title":"Release comments","minLength":1,"type":"string","nullable":true},"release_track":{"title":"Release track","type":"string","nullable":true,"enum":["Alpha","Beta","Production"]},"created_on":{"title":"Created on","type":"string","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","format":"date-time","readOnly":true},"min_sdk_version":{"title":"Min sdk version","maxLength":10,"minLength":1,"type":"string","nullable":true},"target_sdk_version":{"title":"Target sdk version","maxLength":10,"minLength":1,"type":"string","nullable":true},"is_enabled":{"title":"Is enabled","type":"boolean"},"is_default":{"title":"Is Default","type":"boolean"},"enterprise":{"title":"Enterprise","type":"string","format":"url"},"application":{"title":"Application","type":"string","format":"url"},"approval_status":{"title":"Application status","type":"string","enum":["AVAILABLE","ACCEPTED","APPROVED","REJECTED"]}}}},"components/schemas/AppVersionDelete":{"id":"components/schemas/AppVersionDelete","kind":"json-schema","title":"AppVersionDelete","data":{"type":"object","properties":{"request_id":{"title":"Request id","type":"string","format":"uuid"},"templates":{"type":"array","description":"List of linked templates to an app version","items":{"type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Id of the linked template"},"name":{"title":"Name","type":"string","description":"Name of the linked template"}}}}}}},"components/schemas/InstallDevices":{"id":"components/schemas/InstallDevices","kind":"json-schema","title":"InstallDevices","data":{"required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"},"device_name":{"title":"Device name","type":"string"},"alias_name":{"title":"alias name","type":"string","nullable":true},"group_name":{"title":"Group name","maxLength":255,"minLength":1,"type":"string"}}}},"components/schemas/GoogleEnterprise":{"id":"components/schemas/GoogleEnterprise","kind":"json-schema","title":"GoogleEnterprise","data":{"type":"object","required":["name"],"properties":{"id":{"title":"Id","type":"integer"},"google_enterprise_id":{"title":"Google Enterprise Id","type":"string"},"name":{"title":"Name of Google Enterprise","type":"string"},"state":{"type":"integer"},"callback_url":{"type":"string","format":"url"},"signup_url":{"type":"string","format":"url"},"completion_token":{"type":"string"},"enterprise_token":{"type":"string"},"is_active":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"enterprise":{"type":"string"}}}},"components/schemas/GoogleWebToken":{"id":"components/schemas/GoogleWebToken","kind":"json-schema","title":"GoogleWebToken","data":{"type":"object","properties":{"id":{"title":"Id","type":"integer"},"emm":{"title":"emm Id","type":"integer"},"token":{"title":"Webtoken","type":"string"},"parent_url":{"type":"string","format":"url"},"is_active":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"}}}},"components/schemas/GoogleWebTokenUpdate":{"id":"components/schemas/GoogleWebTokenUpdate","kind":"json-schema","title":"GoogleWebTokenUpdate","data":{"type":"object","required":["emm","parent_url"],"properties":{"id":{"title":"Id","type":"integer"},"emm":{"title":"emm Id","type":"integer"},"token":{"title":"Webtoken","type":"string"},"parent_url":{"type":"string","format":"url"},"is_active":{"type":"boolean"}}}},"components/schemas/GoogleWebTokenUpdateNoRequirements":{"id":"components/schemas/GoogleWebTokenUpdateNoRequirements","kind":"json-schema","title":"GoogleWebTokenUpdateNoRequirements","data":{"type":"object","properties":{"id":{"title":"Id","type":"integer"},"emm":{"title":"emm Id","type":"integer"},"token":{"title":"Webtoken","type":"string"},"parent_url":{"type":"string","format":"url"},"is_active":{"type":"boolean"}}}},"components/schemas/GoogleProduct":{"id":"components/schemas/GoogleProduct","kind":"json-schema","title":"GoogleProduct","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"icon_url":{"type":"string","format":"url"},"is_active":{"type":"boolean"},"title":{"type":"string"},"unapproved":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"min_sdk_version":{"type":"string"},"google_product_id":{"type":"string"},"package_name":{"type":"string","minLength":1,"maxLength":255},"google_enterprise":{"type":"integer"}}}},"components/schemas/PatchGoogleProduct":{"id":"components/schemas/PatchGoogleProduct","kind":"json-schema","title":"PatchGoogleProduct","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"icon_url":{"type":"string","format":"url"},"is_active":{"type":"boolean"},"title":{"type":"string"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"min_sdk_version":{"type":"string"},"google_product_id":{"type":"string"},"package_name":{"type":"string","minLength":1,"maxLength":255},"google_enterprise":{"type":"integer"}}}},"components/schemas/GoogleProductInstall":{"id":"components/schemas/GoogleProductInstall","kind":"json-schema","title":"GoogleProductInstall","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"enterprise":{"type":"string"},"device":{"type":"string"},"install_state":{"type":"string"},"version_code":{"type":"string"},"install_type":{"type":"integer","title":"install type- default 0, EMM 1"},"is_force_install":{"type":"boolean"},"reason_details":{"type":"string"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"is_active":{"type":"boolean"},"objects":{"type":"object"}}}},"components/schemas/DeviceStateEnum":{"id":"components/schemas/DeviceStateEnum","kind":"json-schema","title":"DeviceStateEnum","data":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following are the Device States and their description"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 30 = Beginning Provisioning\n* 40 = Configuring Google Play (still provisioning)\n* 50 = Applying Policies and Installing Applications (still provisioning)\n* 60 = Offline\n* 70 = Device is undergoing a Factory Reset (reset started from Dashboard)\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 110 = Android For Work Account added\n* 120 = Apps installed\n* 130 = Branding Processed\n* 140 = Permission Policy Processed\n* 150 = Device Policy Processed\n* 160 = Device Settings Processed\n* 170 = Security Policy Processed\n* 180 = Phone Policy Processed\n* 190 = Custom Settings Processed\n* 200 = Registered\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 30 = Beginning Provisioning\n* 40 = Configuring Google Play (still provisioning)\n* 50 = Applying Policies and Installing Applications (still provisioning)\n* 60 = Offline\n* 70 = Device is undergoing a Factory Reset (reset started from Dashboard)\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 110 = Android For Work Account added\n* 120 = Apps installed\n* 130 = Branding Processed\n* 140 = Permission Policy Processed\n* 150 = Device Policy Processed\n* 160 = Device Settings Processed\n* 170 = Security Policy Processed\n* 180 = Phone Policy Processed\n* 190 = Custom Settings Processed\n* 200 = Registered\n"},"children":[]}]}],"enum":[0,1,20,30,40,50,60,70,80,90,100,110,120,130,140,150,160,170,180,190,200]}},"components/schemas/EmmDevice":{"id":"components/schemas/EmmDevice","kind":"json-schema","title":"EmmDevice","data":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"google_device_id":{"type":"string"},"managementType":{"type":"string"},"device":{"type":"string","format":"uuid"},"google_user":{"type":"integer","format":"int64"},"policy":{"type":"integer","format":"int64"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"is_active":{"type":"boolean","default":true}}}},"components/schemas/DeviceInfo":{"id":"components/schemas/DeviceInfo","kind":"json-schema","title":"DeviceInfo","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"url":{"type":"string","format":"url"},"device_name":{"type":"string"},"alias_name":{"type":"string","description":"Device friendly name"},"policy_name":{"type":"string"},"status":{"type":"integer","description":"Current status of device","format":"int32"},"state":{"$ref":"#/components/schemas/DeviceStateEnum"},"current_command":{"type":"string","description":"Current command associated with device","format":"uuid"},"suid":{"type":"string","description":"Device generated unique id"},"directory_record_id":{"type":"string","format":"uuid","description":"ID of Directory Record associated with the device (if available)"},"fcm_id":{"type":"string"},"enterprise":{"type":"string","format":"url"},"policy":{"type":"string","format":"url"},"user":{"type":"string","format":"url"},"groups":{"type":"array","items":{"type":"string","format":"url"}},"tags":{"type":"array","items":{"type":"string"}},"api_level":{"type":"integer","format":"int32"},"template_name":{"type":"string"},"mqtt_id":{"type":"string"},"softwareInfo":{"type":"object","properties":{}},"hardwareInfo":{"type":"object","properties":{}},"displays":{"type":"object","properties":{}},"networkInfo":{"type":"object","properties":{}},"memoryInfo":{"type":"object","properties":{}},"esper_cient":{"type":"string"},"device_type":{"type":"string"},"audioConstraints":{"type":"object","properties":{}},"provisioned_on":{"type":"string","format":"date-time"},"created_on":{"type":"string","format":"date-time"},"current_app_mode":{"type":"integer"},"kiosk_app_name":{"type":"string"},"lockdown_state":{"type":"integer"},"timezone_string":{"type":"string"},"initialtemplate":{"type":"string"},"updated_on":{"type":"string","format":"date-time"},"emm_device":{"$ref":"#/components/schemas/EmmDevice"},"is_gms":{"type":"boolean","default":true},"is_active":{"type":"boolean","default":true},"has_seamlessInfo":{"type":"boolean","readOnly":true}}}},"components/schemas/DeviceApp":{"id":"components/schemas/DeviceApp","kind":"json-schema","title":"DeviceApp","data":{"required":["app_name","device","package_name"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"app_name":{"title":"App name","minLength":1,"type":"string"},"state":{"type":"string"},"app_type":{"type":"string"},"package_name":{"title":"Package name","maxLength":255,"minLength":1,"type":"string"},"whitelisted":{"title":"Whitelisted","type":"boolean"},"is_data_clearable":{"title":"Data clearable","type":"boolean"},"is_uninstallable":{"title":"Uninstallable","type":"boolean"},"product_id":{"title":"Product id","maxLength":255,"minLength":1,"type":"string","nullable":true},"version_code":{"title":"Version code","maxLength":128,"minLength":1,"type":"string","nullable":true},"version_name":{"title":"Version name","maxLength":128,"minLength":1,"type":"string","nullable":true},"created_on":{"title":"Created on","type":"string","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","format":"date-time","readOnly":true},"is_active":{"title":"Is active","type":"boolean"},"is_kiosk_app":{"type":"boolean"},"is_esper_controlled":{"type":"boolean"},"device":{"title":"AndroidDevice","type":"string","format":"uuid"}}}},"components/schemas/AppInstallVersion":{"id":"components/schemas/AppInstallVersion","kind":"json-schema","title":"Version","data":{"title":"Version","type":"object","properties":{"app_version_id":{"title":"App version id","type":"string","format":"uuid"},"version_code":{"title":"Version code","type":"string"},"build_number":{"title":"Build number","type":"string"},"hash_string":{"title":"Hash string","type":"string"}}}},"components/schemas/AppInstallApplication":{"id":"components/schemas/AppInstallApplication","kind":"json-schema","title":"Application","data":{"title":"Application","type":"object","properties":{"application_name":{"title":"Application name","type":"string"},"package_name":{"title":"Package name","type":"string"},"version":{"$ref":"#/components/schemas/AppInstallVersion"},"is_enabled":{"title":"Is enabled","type":"boolean"}}}},"components/schemas/AppInstallStateEnum":{"id":"components/schemas/AppInstallStateEnum","kind":"json-schema","title":"Install state","data":{"title":"Install state","type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device App Install State"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* INSTALL_IN_PROGRESS = \"Installation In-Progress\"\n* UNINSTALL_IN_PROGRESS = \"Uninstallation In-Progress\"\n* INSTALL_SUCCESS = \"Install Success\"\n* INSTALL_FAILED = \"Install Failed\"\n* UNINSTALL_SUCCESS = \"Uninstall Success\"\n* UNINSTALL_FAILED = \"Uninstall Failed\"\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* INSTALL_IN_PROGRESS = \"Installation In-Progress\"\n* UNINSTALL_IN_PROGRESS = \"Uninstallation In-Progress\"\n* INSTALL_SUCCESS = \"Install Success\"\n* INSTALL_FAILED = \"Install Failed\"\n* UNINSTALL_SUCCESS = \"Uninstall Success\"\n* UNINSTALL_FAILED = \"Uninstall Failed\"\n"},"children":[]}]}],"enum":["NOT_INSTALLED","INSTALL_IN_PROGRESS","UNINSTALL_IN_PROGRESS","INSTALL_SUCCESS","INSTALL_FAILED","UNINSTALL_SUCCESS","UNINSTALL_FAILED"]}},"components/schemas/AppInstall":{"id":"components/schemas/AppInstall","kind":"json-schema","title":"AppInstall","data":{"required":["application","device","enterprise","install_state"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"application":{"$ref":"#/components/schemas/AppInstallApplication"},"install_state":{"$ref":"#/components/schemas/AppInstallStateEnum"},"reason_details":{"title":"Reason details","minLength":1,"type":"string","nullable":true},"created_on":{"title":"Created on","type":"string","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","format":"date-time","readOnly":true},"is_active":{"title":"Is active","type":"boolean"},"enterprise":{"title":"Enterprise","type":"string","format":"url"},"device":{"title":"AndroidDevice","type":"string","format":"url"}}}},"components/schemas/DeviceStatus":{"id":"components/schemas/DeviceStatus","kind":"json-schema","title":"DeviceStatus","data":{"required":["data","device","enterprise"],"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true},"data":{"title":"Data","type":"string"},"created_on":{"title":"Created on","type":"string","format":"date-time","readOnly":true},"device":{"title":"AndroidDevice","type":"string","format":"url"},"enterprise":{"title":"Enterprise","type":"string","format":"url"}}}},"components/schemas/EventFeed":{"id":"components/schemas/EventFeed","kind":"json-schema","title":"EventFeed","data":{"type":"object","properties":{"id":{"type":"integer","description":"Integer representing the event ID"},"message_id":{"type":"string","format":"UUID","description":"UUID string representing message ID"},"device_status_id":{"type":"string","format":"UUID","description":"UUID string representing device status ID"},"created_on":{"type":"string","format":"date-time"},"message":{"type":"string","description":"Message describing the command, who issued it, and from which state it was issued."},"device":{"type":"string","format":"url","description":"URL to device instance","example":"https://{example}-api.esper.cloud/api/enterprise/{enterprise_id}/device/{device_id}/"},"enterprise":{"type":"string","format":"url","description":"URL to enterprise instance","example":"https://{example}-api.esper.cloud/api/enterprise/{enterprise_id}/"}}}},"components/schemas/V0DeviceCommandEnum":{"id":"components/schemas/V0DeviceCommandEnum","kind":"json-schema","title":"V0DeviceCommandEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following commands are supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* ADD_TO_WHITELIST: Whitelist an installed sytem app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* ADD_WIFI_AP : Add wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* CLEAR_APP_DATA : Clear data for an installed app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* INSTALL: Install an app on a device. Requires `app_version` in command arguments where `app_version` is the version id of app uploaded on Esper\n* LOCK: Lock device screen\n* REBOOT: Reboot a device\n* REMOVE_FROM_WHITELIST : Remove an installed system app from whitelist. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* REMOVE_WIFI_AP : Remove Wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* SET_APP_PERMISSION : Set permission for an installed app. Requires `package_name`, `grant_state`, `permission` in command arguments where `package_name` is the app package uploaded on Esper, `grant_state` should be \"PERMISSION_GRANT_STATE_DEFAULT\", \"PERMISSION_GRANT_STATE_DENIED\", \"PERMISSION_GRANT_STATE_GRANTED\" and `permission` is a valid permission\n* SET_APP_STATE : Set the state of an app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN. Requries `app_state` and `package_name` in command arguments where `app_state` is the state of app and `package_name` is the app package uploaded on Esper\n* SET_BLUETOOTH_STATE : Set bluetooth state (ON/OFF) for device. Requires `bluetooth_state` in command arguments where `bluetooth_state` is a boolean.\n* SET_BRIGHTNESS_SCALE : Set brightness for device. Requires `brightness_value` in command arguments where `brightness_value` is an integer (1-100).\n* SET_DEVICE_LOCKDOWN_STATE : Set lockdown state for a device. Requires `state` and `message` in command arguments where `state` is LOCKED/UNLOCKED and `message` is the message to be added with command\n* SET_GPS_STATE :Set the GPS state for a device. Requires `gps_state` in command arguments where `gps_state` should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)\n* SET_KIOSK_APP : Command to set the Kiosk app for a device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* SET_NEW_POLICY : Apply policy on device. Requires `policy_url` in command arguments where `policy_url` is the URL to the policy\n* SET_ROTATION_STATE : Set screen orientation. Requires `rotate_state` in command arguments where `rotate_state` should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)\n* SET_SCREEN_OFF_TIMEOUT: Set screen off timeout for a device. Requires `screen_off_timeout` in command arguments where `screen_off_timeout` should be either -1 or between 5000 and 1800000\n* SET_STREAM_VOLUME : Set stream volume for a device. Requires `stream` and `volume_level` in command arguments where `stream` should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music) and `volume_level` should be a value from 0 to 100\n* SET_TIMEZONE : Set the timezone for a device. Requires `timezone_string` in command arguments where `timezone_string` is a valid string representing the timezone\n* SET_WIFI_STATE : Set the wifi state (ON/OFF) for a device. Requires `wifi_state` in command arguments where `wifi_state` is a boolean.\n* UNINSTALL: Uninstall an app from device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* UPDATE_DEVICE_CONFIG: Push additional configurations to the Device\n* UPDATE_HEARTBEAT: Ping a device\n* UPDATE_LATEST_DPC : Prompt device to update the DPC app to the latest versions.\n* WIPE : Wipes the device.\n* RESET_LOCKSCREEN_PASSWORD: Change the lockscreen password of the device. Requires `new_lockscreen_password` in command arguments where `new_lockscreen_password` is a valid string.\n* CAPTURE_SCREENSHOT: Allows you to take a screenshot of the device's current screen. The \"tag\" is an optional param that can be set to corresponding screenshot.\n* UPDATE_BLUEPRINT: Pushes or reapplies the most current Blueprint version to the device or group.\n* NOTIFY_DEVICE: Allows you to  broadcast message to the device. Requires 'title', 'message' and 'url' (optional) as string in command arguments. For scheduled message command requires 'name', 'time_type' as string and 'start_datetime' and 'end_datetime' as date-time.\n* SET_DEVICE_LANGUAGE: Set language for a device. Requires locale value in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code.\n* SET_ETHERNET_SETTINGS: Set ethernet settings on supported Device\n* SET_STATIC_IP: Set static ip on the deivce. Requires interface, dhcp_dnabled, static_ip, primary_dns, subnet_mask, gateway, secondary_dns (optional)\n* BEEP_DEVICE: Allows you to make the device beep for a specified duration\n* SET_APP_NOTIFICATIONS: Enable/disable app notifications. Requries `app_notifications_state` and `package_name` in command arguments where `app_notifications_state` is a string that has the value `ENABLED` or `DISABLED` and `package_name` is the app package uploaded on Esper.\n* USE_ONLY_SAVED_WIFI_AP: Allow/disallow device to connect to unregistered WiFi APs. Requires boolean `use_only_saved_ap`.\n* CONVERGE: Allows you to converge the device to the latest version of its assigned blueprint.\n* SYNC_CONTENT: Allows you to sync content to the device. Requires `content_id` in command arguments where `content_id` is the id of the content to be synced. ```\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* ADD_TO_WHITELIST: Whitelist an installed sytem app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* ADD_WIFI_AP : Add wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* CLEAR_APP_DATA : Clear data for an installed app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* INSTALL: Install an app on a device. Requires `app_version` in command arguments where `app_version` is the version id of app uploaded on Esper\n* LOCK: Lock device screen\n* REBOOT: Reboot a device\n* REMOVE_FROM_WHITELIST : Remove an installed system app from whitelist. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* REMOVE_WIFI_AP : Remove Wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* SET_APP_PERMISSION : Set permission for an installed app. Requires `package_name`, `grant_state`, `permission` in command arguments where `package_name` is the app package uploaded on Esper, `grant_state` should be \"PERMISSION_GRANT_STATE_DEFAULT\", \"PERMISSION_GRANT_STATE_DENIED\", \"PERMISSION_GRANT_STATE_GRANTED\" and `permission` is a valid permission\n* SET_APP_STATE : Set the state of an app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN. Requries `app_state` and `package_name` in command arguments where `app_state` is the state of app and `package_name` is the app package uploaded on Esper\n* SET_BLUETOOTH_STATE : Set bluetooth state (ON/OFF) for device. Requires `bluetooth_state` in command arguments where `bluetooth_state` is a boolean.\n* SET_BRIGHTNESS_SCALE : Set brightness for device. Requires `brightness_value` in command arguments where `brightness_value` is an integer (1-100).\n* SET_DEVICE_LOCKDOWN_STATE : Set lockdown state for a device. Requires `state` and `message` in command arguments where `state` is LOCKED/UNLOCKED and `message` is the message to be added with command\n* SET_GPS_STATE :Set the GPS state for a device. Requires `gps_state` in command arguments where `gps_state` should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)\n* SET_KIOSK_APP : Command to set the Kiosk app for a device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* SET_NEW_POLICY : Apply policy on device. Requires `policy_url` in command arguments where `policy_url` is the URL to the policy\n* SET_ROTATION_STATE : Set screen orientation. Requires `rotate_state` in command arguments where `rotate_state` should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)\n* SET_SCREEN_OFF_TIMEOUT: Set screen off timeout for a device. Requires `screen_off_timeout` in command arguments where `screen_off_timeout` should be either -1 or between 5000 and 1800000\n* SET_STREAM_VOLUME : Set stream volume for a device. Requires `stream` and `volume_level` in command arguments where `stream` should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music) and `volume_level` should be a value from 0 to 100\n* SET_TIMEZONE : Set the timezone for a device. Requires `timezone_string` in command arguments where `timezone_string` is a valid string representing the timezone\n* SET_WIFI_STATE : Set the wifi state (ON/OFF) for a device. Requires `wifi_state` in command arguments where `wifi_state` is a boolean.\n* UNINSTALL: Uninstall an app from device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* UPDATE_DEVICE_CONFIG: Push additional configurations to the Device\n* UPDATE_HEARTBEAT: Ping a device\n* UPDATE_LATEST_DPC : Prompt device to update the DPC app to the latest versions.\n* WIPE : Wipes the device.\n* RESET_LOCKSCREEN_PASSWORD: Change the lockscreen password of the device. Requires `new_lockscreen_password` in command arguments where `new_lockscreen_password` is a valid string.\n* CAPTURE_SCREENSHOT: Allows you to take a screenshot of the device's current screen. The \"tag\" is an optional param that can be set to corresponding screenshot.\n* UPDATE_BLUEPRINT: Pushes or reapplies the most current Blueprint version to the device or group.\n* NOTIFY_DEVICE: Allows you to  broadcast message to the device. Requires 'title', 'message' and 'url' (optional) as string in command arguments. For scheduled message command requires 'name', 'time_type' as string and 'start_datetime' and 'end_datetime' as date-time.\n* SET_DEVICE_LANGUAGE: Set language for a device. Requires locale value in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code.\n* SET_ETHERNET_SETTINGS: Set ethernet settings on supported Device\n* SET_STATIC_IP: Set static ip on the deivce. Requires interface, dhcp_dnabled, static_ip, primary_dns, subnet_mask, gateway, secondary_dns (optional)\n* BEEP_DEVICE: Allows you to make the device beep for a specified duration\n* SET_APP_NOTIFICATIONS: Enable/disable app notifications. Requries `app_notifications_state` and `package_name` in command arguments where `app_notifications_state` is a string that has the value `ENABLED` or `DISABLED` and `package_name` is the app package uploaded on Esper.\n* USE_ONLY_SAVED_WIFI_AP: Allow/disallow device to connect to unregistered WiFi APs. Requires boolean `use_only_saved_ap`.\n* CONVERGE: Allows you to converge the device to the latest version of its assigned blueprint.\n* SYNC_CONTENT: Allows you to sync content to the device. Requires `content_id` in command arguments where `content_id` is the id of the content to be synced. ```\n"},"children":[]}]}],"enum":["ADD_TO_WHITELIST","ADD_WIFI_AP","CLEAR_APP_DATA","INSTALL","LOCK","REBOOT","REMOVE_FROM_WHITELIST","REMOVE_WIFI_AP","SET_APP_PERMISSION","SET_APP_STATE","SET_BLUETOOTH_STATE","SET_BRIGHTNESS_SCALE","SET_DEVICE_LOCKDOWN_STATE","SET_GPS_STATE","SET_KIOSK_APP","SET_NEW_POLICY","SET_ROTATION_STATE","SET_SCREEN_OFF_TIMEOUT","SET_STREAM_VOLUME","SET_TIMEZONE","SET_WIFI_STATE","UNINSTALL","UPDATE_DEVICE_CONFIG","UPDATE_HEARTBEAT","UPDATE_LATEST_DPC","WIPE","RESET_LOCKSCREEN_PASSWORD","UPDATE_BLUEPRINT","CAPTURE_SCREENSHOT","NOTIFY_DEVICE","SET_DEVICE_LANGUAGE","SET_ETHERNET_SETTINGS","SET_STATIC_IP","BEEP_DEVICE","SET_APP_NOTIFICATIONS","USE_ONLY_SAVED_WIFI_AP","CONVERGE","SYNC_CONTENT"]}},"components/schemas/V0CommandArgs":{"id":"components/schemas/V0CommandArgs","kind":"json-schema","title":"Command args","data":{"title":"Command args","type":"object","properties":{"device_alias_name":{"type":"string","description":"Alternate human-readable name for your Device"},"custom_settings_config":{"type":"object","properties":{},"description":"Managed configurations for your device (passed as JSON object)"},"app_version":{"type":"string","description":"The version id of app uploaded on Esper"},"package_name":{"type":"string","description":"The app package name uploaded on Esper"},"policy_url":{"type":"string","description":"The URL to the policy"},"wifi_access_points":{"type":"object","properties":{},"description":"Wifi access points for the device (passed as JSON object)"},"state":{"type":"string","description":"LOCKED/UNLOCKED"},"message":{"type":"string","description":"Message to be added with command to notify device."},"title":{"type":"string","description":"Message title  to be added with command to notify device."},"url":{"type":"string","description":"(Optional) Link to notify device."},"app_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN"},"children":[]}]}]}]},"bluetooth_state":{"type":"boolean","description":"The state of bluetooth - ON/OFF"},"brightness_value":{"type":"integer","description":"The brightness value of a device(1-100)"},"gps_state":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The GPS state of a device. Should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)"},"children":[]}]}]}]},"rotate_state":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The screen orientation of a device. Should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)"},"children":[]}]}]}]},"screen_off_timeout":{"type":"integer","description":"The value for screen timeout of a device. Should be either -1 or between 5000 and 1800000"},"stream":{"type":"integer","description":"The value of the volume stream. Should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music)"},"volume_level":{"type":"integer","description":"The level of volume. Should be a value from 0 to 100"},"timezone_string":{"type":"integer","description":"The timezone of a device. Should be a valid timezone string"},"wifi_state":{"type":"boolean","description":"The state of WIFI - ON/OFF"},"wifi_revert_timeout":{"type":"integer","description":"The WIFI revert timeout. Should be greater than or equal to 1"},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language and country code in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code."},"children":[]}]}]}]},"ethernet_auth_mode":{"type":"string","description":"Chosen mode of authentication","enum":["NONE","EAP_TLS"]},"ethernet_ca_cert_alias":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA certificate alias. It is mandatory with Auth Mode EAP_TLS"},"children":[]}]}]}]},"ethernet_client_cert_alias":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client certificate alias. It is mandatory with Auth Mode EAP_TLS"},"children":[]}]}]}]},"ethernet_eap_identity":{"type":"string","description":"EAP identity"},"interface":{"type":"string","description":"The network interface of the device - wlan/eth"},"dhcp_enabled":{"type":"string","description":"The dhcp state on the device - true/false"},"static_ip":{"type":"string","description":"The static ip to set on the device. Should be a valid ipv4"},"primary_dns":{"type":"string","description":"The primary dns to set on the device. Should be a valid ipv4"},"subnet_mask":{"type":"string","description":"The subnet mask set on the device. Should between 1-32 both inclusive"},"secondary_dns":{"type":"string","description":"The secondary dns to set on the device. Should be a valid ipv4"},"gateway":{"type":"string","description":"The gateway to set on the device. Should be a valid ipv4"},"duration":{"type":"string","description":"The beep duration specified in seconds. Value must be between 10 and 300, both inclusive."},"tag":{"type":"string","description":"The tag is an optional param that can be set to corresponding screenshot. Options are \"tag\"."},"video_quality":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The video quality of the respective Remote Viewer session. Options are \"STANDARD\" and \"DATA_SAVER\"."},"children":[]}]}]}]},"enable_debug_mode":{"type":"boolean","default":false,"description":"The flag to determine whether device must go into Debug Mode, in order to retreive bug report when the device is already in Kiosk Mode."},"converge_with_provision_option":{"type":"boolean","default":false,"description":"The flag to determine whether device should be converged with provision only or not."},"auto_update_mode":{"type":"string","enum":["autoUpdateDefault","autoUpdateHighPriority","autoUpdatePostponed"],"default":"autoUpdateHighPriority","description":"(Optional) Auto update mode for google play application"},"content_id":{"type":"string","description":"The id of the content to be synced."}}}},"components/schemas/V0CommandScheduleEnum":{"id":"components/schemas/V0CommandScheduleEnum","kind":"json-schema","title":"V0CommandScheduleEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule types are supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n* RECURRING: Schedule the command to execute during the scheduled time until it succeeds or expires. After executing successfully, it will not fire again.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n* RECURRING: Schedule the command to execute during the scheduled time until it succeeds or expires. After executing successfully, it will not fire again.\n"},"children":[]}]}],"enum":["IMMEDIATE","WINDOW","RECURRING"]}},"components/schemas/V0CommandScheduleArgsTimeTypeEnum":{"id":"components/schemas/V0CommandScheduleArgsTimeTypeEnum","kind":"json-schema","title":"V0CommandScheduleArgsTimeTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Time-Type argument, in Schedule args, is to indicate which timezone the Command Framework should utilize when scheduling the command."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule Args for Time-Type are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* CONSOLE: Use the local timezone of the user creating the schedule.\n* DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* CONSOLE: Use the local timezone of the user creating the schedule.\n* DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be.\n"},"children":[]}]}],"enum":["console","device"]}},"components/schemas/V0CommandScheduleArgs":{"id":"components/schemas/V0CommandScheduleArgs","kind":"json-schema","title":"Command Schedule Arguments","data":{"title":"Command Schedule Arguments","type":"object","properties":{"name":{"type":"string"},"start_datetime":{"type":"string","format":"date-time"},"end_datetime":{"type":"string","format":"date-time"},"time_type":{"$ref":"#/components/schemas/V0CommandScheduleArgsTimeTypeEnum"},"window_start_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is automatically populated by the time field from the request's start_datetime and cannot be injected via the API request body."},"children":[]}]}]}]},"window_end_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is automatically populated by the time field from the request's end_datetime and cannot be injected via the API request body."},"children":[]}]}]}]},"days":{"type":"array","items":{"type":"string"}}}}},"components/schemas/V0CommandRequestStatus":{"id":"components/schemas/V0CommandRequestStatus","kind":"json-schema","title":"V0CommandRequestStatus","data":{"type":"object","properties":{"state":{"title":"Command State","type":"string","description":"Current State of command","format":"uuid"},"total":{"title":"Count","type":"integer","description":"No of commands currently in this state","format":"int64"}}}},"components/schemas/V0CommandRequest":{"id":"components/schemas/V0CommandRequest","kind":"json-schema","title":"V0CommandRequest","data":{"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Unique command request identifier","format":"uuid","readOnly":true},"enterprise":{"title":"Enterperise ID","type":"string","description":"Esper account identifier","format":"uuid","readOnly":true},"command_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of command"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* DEVICE: command request is meant for devices\n* GROUP: command request is meant for groups\n* DYNAMIC: command request is meant for dynamic set of devices\n  i.e subset of devices from different groups or otherwise.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* DEVICE: command request is meant for devices\n* GROUP: command request is meant for groups\n* DYNAMIC: command request is meant for dynamic set of devices\n  i.e subset of devices from different groups or otherwise.\n"},"children":[]}]}],"enum":["DEVICE","GROUP","DYNAMIC"]},"devices":{"maxItems":1000,"minItems":0,"type":"array","description":"list of devices to run commands","items":{"type":"string","format":"uuid"}},"groups":{"maxItems":500,"minItems":0,"type":"array","description":"list of groups to run commands","items":{"type":"string","format":"uuid"}},"command":{"$ref":"#/components/schemas/V0DeviceCommandEnum"},"command_args":{"$ref":"#/components/schemas/V0CommandArgs"},"schedule":{"$ref":"#/components/schemas/V0CommandScheduleEnum"},"schedule_args":{"$ref":"#/components/schemas/V0CommandScheduleArgs"},"issued_by":{"type":"string","description":"command is issued by this user","format":"url","readOnly":true},"created_on":{"title":"Created on","type":"string","description":"Timestamp of command request","format":"date-time","readOnly":true},"status":{"title":"Current Status","type":"array","description":"Show current status of commands issued during this request","readOnly":true,"items":{"$ref":"#/components/schemas/V0CommandRequestStatus"}}}}},"components/schemas/DeviceGroup":{"id":"components/schemas/DeviceGroup","kind":"json-schema","title":"DeviceGroup","data":{"required":["name"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Group id","format":"uuid","readOnly":true},"name":{"title":"Name","type":"string","description":"Group name"},"created_on":{"title":"Created on","type":"string","description":"Date and time of when the group was created","format":"date-time","readOnly":true},"enterprise":{"title":"Enterprise","type":"string","description":"Enterprise url","format":"url","readOnly":true},"parent":{"title":"Parent","type":"string","description":"Parent group url","format":"url"},"device_count":{"title":"Device count","type":"integer","description":"Count of devices in the group","readOnly":true},"path":{"title":"Path","type":"string","description":"Path of the group","readOnly":true},"children_count":{"title":"Children count","type":"integer","description":"Count of child groups","readOnly":true},"thumbnail":{"title":"thumbnail","description":"thumbnail associated with the group","type":"string","format":"uuid"},"blueprint":{"title":"Blueprint","description":"Blueprint associated with the group.","type":"string","format":"uuid","readOnly":true}}}},"components/schemas/DeviceGroupUpdate":{"id":"components/schemas/DeviceGroupUpdate","kind":"json-schema","title":"DeviceGroupUpdate","data":{"required":["name"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Group id","format":"uuid","readOnly":true},"name":{"title":"Name","type":"string","description":"Group name"},"created_on":{"title":"Created on","type":"string","description":"Date and time of when the group was created","format":"date-time","readOnly":true},"enterprise":{"title":"Enterprise","type":"string","description":"Enterprise url","format":"url","readOnly":true},"parent":{"title":"Parent","type":"string","description":"Parent group id","format":"uuid"},"device_ids":{"title":"Device ids","uniqueItems":true,"type":"array","description":"Devices ids","items":{"type":"string","format":"uuid"}},"device_count":{"title":"Device count","type":"integer","readOnly":true},"path":{"title":"Path","type":"string","description":"Path of the group","readOnly":true},"children_count":{"title":"Children Count","type":"integer","description":"Count of child groups","readOnly":true}}}},"components/schemas/DeviceGroupPartialUpdate":{"id":"components/schemas/DeviceGroupPartialUpdate","kind":"json-schema","title":"DeviceGroupPartialUpdate","data":{"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Group id","format":"uuid","readOnly":true},"name":{"title":"Name","type":"string","description":"Group name"},"created_on":{"title":"Created on","type":"string","description":"Date and time of when the group was created","format":"date-time","readOnly":true},"enterprise":{"title":"Enterprise","type":"string","description":"Enterprise url","format":"url","readOnly":true},"parent":{"title":"Parent","type":"string","description":"Parent group id","format":"uuid"},"device_ids":{"title":"Device ids","uniqueItems":true,"type":"array","description":"Device ids","items":{"type":"string","format":"uuid"}},"device_count":{"title":"Device count","type":"integer","description":"Count of devices in the group","readOnly":true},"path":{"title":"Path","type":"string","description":"Path of the group","readOnly":true},"children_count":{"title":"Children Count","type":"integer","description":"Count of child groups","readOnly":true}}}},"components/schemas/GroupThumbnail":{"id":"components/schemas/GroupThumbnail","kind":"json-schema","title":"GroupThumbnail","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"image_file":{"type":"string","readOnly":true},"thumbnail_url":{"type":"string","readOnly":true},"created_on":{"type":"string","format":"date-time","readOnly":true}}}},"components/schemas/DeviceSubGroup":{"id":"components/schemas/DeviceSubGroup","kind":"json-schema","title":"DeviceSubGroup","data":{"type":"object","properties":{"subgroups":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"components/schemas/EnterprisePolicyData":{"id":"components/schemas/EnterprisePolicyData","kind":"json-schema","title":"Policy Data","data":{"title":"Policy Data","type":"object","properties":{"keyguardDisabled":{"type":"boolean","description":"Should KeyGuard be disabled?"},"safeBootDisabled":{"type":"boolean","description":"Should SafeBoot be disabled?"},"statusBarDisabled":{"type":"boolean","description":"Should Status Bar be disabled?"},"factoryResetDisabled":{"type":"boolean","description":"Should Factory Reset be disabled?"},"screenshotDisabled":{"type":"boolean","description":"Should Screenshot capability be disabled?"},"usbConnectivityDisabled":{"type":"boolean","description":"Should USB connectivity be disabled?"},"smsDisabled":{"type":"boolean","description":"Should SMS functionality be disabled?"},"outgoingCallsDisabled":{"type":"boolean","description":"Should Outgoing Calls be disabled?"},"cameraDisabled":{"type":"boolean","description":"Should Camera be disabled?"},"nfcBeamDisabled":{"type":"boolean","description":"Should NFC capability be disabled?"},"disablePlayStore":{"type":"boolean","description":"Should Google Play Store be disabled on the device?"},"usbFileTransferDisabled":{"type":"boolean","description":"Should USB File transfer capability be disabled?"},"tetheringDisabled":{"type":"boolean","description":"Should USB Tethering capability be enabled?"},"dateTimeConfigDisabled":{"type":"boolean","description":"Should Date/Time configuration capability be disabled?"},"appUninstallDisabled":{"type":"boolean","description":"Should App uninstall capability be disabled?"},"googleAssistantDisabled":{"type":"boolean","description":"Should Google Assistant feature be disabled?"},"disableLocalAppInstall":{"type":"boolean","description":"Should Side-loading of Applications be disabled?"},"adbDisabled":{"type":"boolean","description":"Should Android Debugger be disabled?"},"phonePolicy":{"type":"object","properties":{"incomingNumbers":{"type":"array","description":"List of permitted incoming phone numbers to recieve calls from","items":{"maxLength":15,"type":"string"}},"outgoingNumbers":{"type":"array","description":"List of permitted outgoing phone numbers to make calls to","items":{"maxLength":15,"type":"string"}},"dialer":{"type":"string","description":"Pick a dialer - System default or Esper Dialer","enum":["DEFAULT","SHOONYA"]},"allowUssdCodes":{"type":"boolean","default":false,"description":"Allow USSD codes to be dialed. Default is false"}},"description":"Rules regarding restricting calls from/to phone-numbers"},"frpGoogles":{"type":"array","description":"Details regarding Factory Reset Protection capability. List of permitted Google People IDs, emails and such","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of User account provided - USER or ADMIN","enum":["USER","ADMIN"]},"email":{"type":"string","description":"Email id to be used for Factory protection. This will be asked on the Device's UI","format":"email"},"googleId":{"type":"string","description":"Google People ID associated with the above email (https://developers.google.com/people/api/rest/v1/people/get)"}}}},"googleAccountPermission":{"type":"object","properties":{"maxAccount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of Google accounts to be associated with this device. (Max = 10)"},"children":[]}]}]}]},"emails":{"type":"array","description":"List of emails to be associated","items":{"type":"string","format":"email"}},"domains":{"type":"array","description":"List of domains that can be associated","items":{"type":"string"}}},"description":"Details regarding Google accounts to be associated with the device"},"devicePasswordPolicy":{"type":"object","properties":{"passwordQuality":{"type":"string","description":"What is the type of password quality to apply to the device?","enum":["PASSWORD_QUALITY_ALPHABETIC","PASSWORD_QUALITY_ALPHANUMERIC","PASSWORD_QUALITY_BIOMETRIC_WEAK","PASSWORD_QUALITY_COMPLEX","PASSWORD_QUALITY_NUMERIC","PASSWORD_QUALITY_NUMERIC_COMPLEX","PASSWORD_QUALITY_SOMETHING","PASSWORD_QUALITY_UNSPECIFIED"]}},"description":"Define the Password Policy for the device"},"minimumPasswordLength":{"minimum":4,"type":"integer","description":"What is the minimum length for your device's password"},"permissionPolicy":{"type":"string","description":"What permission should be applied by default for all apps, henceforth?","enum":["PERMISSION_POLICY_PROMPT","PERMISSION_POLICY_AUTO_GRANT","PERMISSION_POLICY_AUTO_DENY"]},"deviceUpdatePolicy":{"type":"object","properties":{"type":{"type":"string","description":"What type of installation is preferred?","enum":["TYPE_INSTALL_AUTOMATIC","TYPE_POSTPONE","TYPE_INSTALL_WINDOWED","TYPE_INSTALL_DISABLED"]},"maintenanceStart":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TYPE_INSTALL_WINDOWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when should the maintenance start?"},"children":[]}]}]}]},"maintenanceEnd":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TYPE_INSTALL_WINDOWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when should the maintenance end?"},"children":[]}]}]}]}},"description":"Configuration regarding Device OS Updates"},"settingsAccessLevel":{"type":"string","description":"Type of Android settings app to be applied? Default System Settings or ESPER Settings App?","enum":["SYSTEM","SHOONYA","NONE"]},"settingsAppPassword":{"type":"string","description":"Lock Password (optional) for the ESPER Settings app","format":"password"}}}},"components/schemas/EnterprisePolicy":{"id":"components/schemas/EnterprisePolicy","kind":"json-schema","title":"EnterprisePolicy","data":{"required":["enterprise","name","policy"],"type":"object","properties":{"uuid":{"title":"UUID","type":"string","description":"Unique Policy identifier","format":"uuid","readOnly":true},"enterprise":{"title":"Enterprise url","type":"string","description":"Url of the enterprise resource","format":"url"},"url":{"title":"Policy URL","type":"string","description":"URL link to policy","format":"url","readOnly":true},"name":{"title":"Policy Name","type":"string","description":"Name of the Policy"},"description":{"title":"Policy Description","type":"string","description":"Details regarding the Policy"},"device_count":{"title":"Number of Devices with this policy applied","type":"integer","description":"Count of Devices with this policy applied","readOnly":true},"google_policy_id":{"title":"Google policy id","type":"string","description":"Id of the Google policy","readOnly":true},"policy":{"$ref":"#/components/schemas/EnterprisePolicyData"},"updated_on":{"title":"Updated On","type":"string","description":"Last-Updated Timestamp of Policy","format":"date-time","readOnly":true},"created_on":{"title":"Created on","type":"string","description":"Creation Timestamp of Policy","format":"date-time","readOnly":true},"is_active":{"title":"Policy Active status","type":"boolean","description":"Is this policy currently active"}}}},"components/schemas/EnterprisePolicyPartialUpdate":{"id":"components/schemas/EnterprisePolicyPartialUpdate","kind":"json-schema","title":"EnterprisePolicyPartialUpdate","data":{"type":"object","properties":{"uuid":{"title":"UUID","type":"string","description":"Unique Policy identifier","format":"uuid","readOnly":true},"enterprise":{"title":"Enterprise url","type":"string","description":"Url of the enterprise resource","format":"url"},"url":{"title":"Policy URL","type":"string","description":"URL link to policy","format":"url","readOnly":true},"name":{"title":"Policy Name","type":"string","description":"Name of the Policy"},"description":{"title":"Policy Description","type":"string","description":"Details regarding the Policy"},"device_count":{"title":"Number of Devices with this policy applied","type":"integer","description":"Count of Devices with this policy applied","readOnly":true},"policy":{"$ref":"#/components/schemas/EnterprisePolicyData"},"updated_on":{"title":"Updated On","type":"string","description":"Last-Updated Timestamp of Policy","format":"date-time","readOnly":true},"created_on":{"title":"Created on","type":"string","description":"Creation Timestamp of Policy","format":"date-time","readOnly":true},"is_active":{"title":"Policy Active status","type":"boolean","description":"Is this policy currently active"},"google_policy_id":{"title":"Google policy id","type":"string","description":"Id of the Google policy","readOnly":true}}}},"components/schemas/V0CommandStatus1":{"id":"components/schemas/V0CommandStatus1","kind":"json-schema","title":"V0CommandStatus1","data":{"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Unique command identifier","format":"uuid","readOnly":true},"request":{"title":"Request Id","type":"string","description":"Request Id associated with this command","format":"uuid","readOnly":true},"device":{"title":"AndroidDevice","type":"string","description":"Device associated with this command","format":"url","readOnly":true},"state":{"type":"string","description":"Current state of the command","enum":["Command Queued","Command Initiated","Command Acknowledged","Command In Progress","Command TimeOut","Command Success","Command Failure","Command Scheduled","Command Cancelled"]},"reason":{"type":"string","description":"details briefing the reason for current command state"},"created_on":{"title":"Created on","type":"string","description":"Timestamp of command creation","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","description":"Last updated timestamp of command","format":"date-time","readOnly":true},"meta":{"type":"object","properties":{"device":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"device_name":{"type":"string"},"alias_name":{"type":"string","nullable":true},"timezone_string":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"},"nullable":true,"description":"Tags associated with the device"},"managed_by":{"type":"string","enum":["BLUEPRINT","TEMPLATE"],"description":"Indicates whether the device is managed by a Blueprint or Template"}}}}}}}},"components/schemas/Content":{"id":"components/schemas/Content","kind":"json-schema","title":"Content","data":{"required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"integer","description":"Unique content Identifier","readOnly":true},"download_url":{"title":"Content download URL","type":"string","description":"URL to download the content","format":"url"},"name":{"title":"Name","type":"string","description":"Name of the content"},"key":{"title":"Key","maxLength":255,"minLength":1,"type":"string"},"is_dir":{"title":"Is Directory","type":"boolean","default":false},"kind":{"title":"Content kind","maxLength":255,"type":"string","description":"The mime type of the content","nullable":true},"hash":{"title":"Content Hash","type":"string","description":"Hash string of the content"},"size":{"title":"Content Size","maxLength":255,"type":"string","description":"Size of the content in bytes"},"path":{"title":"Path","type":"string","description":"Path to the content"},"permissions":{"title":"Permissions","type":"string","description":"The permssion string for the content"},"tags":{"title":"Content tags","type":"array","description":"Tags for the content","items":{"maxLength":255,"type":"string"}},"description":{"title":"Content description","type":"string","description":"Description for the content","nullable":true},"created":{"title":"Created on","type":"string","format":"date-time","readOnly":true},"modified":{"title":"Modified on","type":"string","format":"date-time","readOnly":true},"enterprise":{"title":"Enterprise","type":"string","description":"URL of the enterprise resource","format":"url"},"owner":{"title":"Owner","type":"object","properties":{"id":{"type":"integer"},"username":{"type":"string"}},"description":"Owner of the content"}}}},"components/schemas/AlertChannelsV1":{"id":"components/schemas/AlertChannelsV1","kind":"json-schema","title":"AlertChannelsV1","data":{"type":"object","properties":{"id":{"type":"integer"},"properties":{"type":"object","properties":{"to_address":{"type":"string","format":"email"}}},"name":{"type":"string"},"type":{"type":"string","description":"format of alert. e.g. email"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"enterprise":{"type":"string","format":"uuid"},"linked_alerts":{"type":"array","items":{"type":"string"}}}}},"components/schemas/UpdateAlertChannelsV1":{"id":"components/schemas/UpdateAlertChannelsV1","kind":"json-schema","title":"UpdateAlertChannelsV1","data":{"type":"object","properties":{"id":{"type":"integer"},"properties":{"type":"object","properties":{"to_address":{"type":"string","format":"email"}}},"name":{"type":"string"},"type":{"type":"string","description":"format of alert. e.g. email"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"enterprise":{"type":"string","format":"uuid"}}}},"components/schemas/AlarmRule":{"id":"components/schemas/AlarmRule","kind":"json-schema","title":"AlarmRule","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"enterprise":{"type":"string","format":"uuid"},"devices":{"properties":{"id":{"type":"string","format":"uuid"},"device_name":{"type":"string"},"alias_name":{"type":"string","nullable":true}}},"groups":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"description":{"type":"string"},"metric":{"type":"string"},"conditions":{"properties":{"value":{"type":"number","format":"double"},"unit":{"type":"string"},"comparator":{"type":"string"},"toggle_state":{"type":"boolean"}}},"action_emails":{"type":"array","items":{"type":"string","format":"email"}},"actions":{"type":"array","items":{"type":"string"}},"alert_channels":{"type":"array","items":{"type":"string"}},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"is_active":{"type":"boolean"},"realert_interval":{"type":"integer"},"repeat_times":{"type":"integer"},"trigger_count":{"type":"integer"},"daily_trigger_count":{"type":"integer"}}}},"components/schemas/UpdateAlarmRule":{"id":"components/schemas/UpdateAlarmRule","kind":"json-schema","title":"UpdateAlarmRule","data":{"type":"object","required":["enterprise","name","metric","conditions","realert_interval"],"properties":{"id":{"type":"string","format":"uuid"},"enterprise":{"type":"string","format":"uuid"},"devices":{"type":"array","items":{"format":"string"}},"groups":{"type":"array","items":{"type":"string"}},"name":{"type":"string"},"description":{"type":"string"},"metric":{"type":"string"},"conditions":{"properties":{"value":{"type":"number","format":"double"},"unit":{"type":"string"},"comparator":{"type":"string"},"toggle_state":{"type":"boolean"}}},"action_emails":{"type":"array","items":{"type":"string","format":"email"}},"actions":{"type":"array","items":{"type":"string"}},"alert_channels":{"type":"array","items":{"type":"string"}},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"},"is_active":{"type":"boolean"},"realert_interval":{"type":"integer"},"repeat_times":{"type":"integer"},"trigger_count":{"type":"integer"},"daily_trigger_count":{"type":"integer"}}}},"components/schemas/AlarmHistory":{"id":"components/schemas/AlarmHistory","kind":"json-schema","title":"AlarmHistory","data":{"type":"object","properties":{"device_name":{"type":"string"},"device_id":{"type":"string","format":"uuid"},"group_id":{"type":"array","items":{"format":"string"},"description":"lists group id's in uuid format"},"group_name":{"type":"string"},"alert_time":{"type":"string","format":"date-time"},"latest_seen":{"type":"string","format":"date-time"}}}},"components/schemas/Wallpaper":{"id":"components/schemas/Wallpaper","kind":"json-schema","title":"Wallpaper","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"enterprise":{"type":"string","format":"uuid"},"image_file":{"type":"string","format":"url"},"thumbnail":{"type":"string","format":"url"},"orientation":{"type":"string"},"is_active":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"}}}},"components/schemas/TileIcon":{"id":"components/schemas/TileIcon","kind":"json-schema","title":"TileIcon","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"category":{"type":"string"},"icon_file":{"type":"string","format":"url"},"device_model":{"type":"string"},"custom":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"}}}},"components/schemas/ApplyTileIcon":{"id":"components/schemas/ApplyTileIcon","kind":"json-schema","title":"ApplyTileIcon","data":{"type":"object","properties":{"icon":{"type":"string","format":"uuid","nullable":true},"apply_mode":{"type":"string","enum":["devices","all_devices","groups","device_model"],"default":"devices"},"device_model":{"type":"string","nullable":true},"devices":{"type":"array","items":{"format":"string"}},"groups":{"type":"array","items":{"type":"string"}}}}},"components/schemas/DeviceLocations":{"id":"components/schemas/DeviceLocations","kind":"json-schema","title":"DeviceLocations","data":{"type":"object","properties":{"id":{"type":"integer"},"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"altitude":{"type":"number","format":"double"},"city":{"type":"string"},"status":{"type":"string"},"country":{"type":"string"},"zipcode":{"type":"integer"},"last_updated_on":{"type":"string","format":"date-time"},"device":{"type":"string","format":"url"},"enterprise":{"type":"string","format":"url"}}}},"components/schemas/SecurityStatesEnum":{"id":"components/schemas/SecurityStatesEnum","kind":"json-schema","title":"SecurityStatesEnum","data":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following are the Security States and their description"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  * 1 = SECURE\n  * 10 = LOW_RISK\n  * 20 = MEDIUM_RISK\n  * 30 = HIGH_RISK\n  * 100 = DEVICE_STATE_UNSPECIFIED\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  * 1 = SECURE\n  * 10 = LOW_RISK\n  * 20 = MEDIUM_RISK\n  * 30 = HIGH_RISK\n  * 100 = DEVICE_STATE_UNSPECIFIED\n"},"children":[]}]}],"enum":[1,10,20,30,100]}},"components/schemas/DeviceTiles":{"id":"components/schemas/DeviceTiles","kind":"json-schema","title":"DeviceTiles","data":{"type":"object","properties":{"id":{"type":"integer"},"device":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"groups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"url":{"type":"string","format":"url"}}}},"device_name":{"type":"string"},"state":{"type":"integer"},"tags":{"type":"string","nullable":true},"device_type":{"type":"string"},"serial":{"type":"string"},"imeis":{"type":"object"},"android_version":{"type":"integer"},"eea_version":{"type":"string"},"manufacturer":{"type":"string"},"api_level":{"type":"integer"},"template_name":{"type":"string"},"dpc_version":{"type":"string"},"alias_name":{"type":"string"},"provisioned_on":{"type":"string","format":"date-time"},"geofence_id":{"type":"string","format":"uuid"}}},"network_info":{"type":"object","properties":{"__faust":{"type":"object","properties":{"ns":{"type":"string"}}},"mobileIPv4":{"type":"string","nullable":true},"mobileIPv6":{"type":"string","nullable":true},"networkType":{"type":"string","nullable":true},"numberOfSim":{"type":"integer"},"simOperator":{"type":"array","items":{"type":"string"}},"signalStrength":{"type":"string","nullable":true},"networkOperator":{"type":"array","items":{"type":"string"}},"mobileNetworkStatus":{"type":"string"},"currentActiveConnection":{"type":"string"}}},"model":{"type":"string"},"location":{"type":"object","nullable":true},"battery_level":{"type":"number","format":"double"},"security_state":{"type":"string"},"security_reason":{"type":"string"},"security_advise":{"type":"string"},"wifi_ssid":{"type":"string","nullable":true},"updated_on":{"type":"string","format":"date-time"},"created_on":{"type":"string","format":"date-time"},"is_active":{"type":"boolean"},"is_gms":{"type":"boolean"},"status_id":{"type":"integer","nullable":true},"serial_no":{"type":"string"},"android_version":{"type":"integer"},"eea_version":{"type":"string"},"dpc_version":{"type":"string"},"location_city":{"type":"string"},"network_type":{"type":"string"},"enterprise":{"type":"string","format":"url"},"icon":{"type":"string","nullable":true}}}},"components/schemas/StatusMetrics":{"id":"components/schemas/StatusMetrics","kind":"json-schema","title":"StatusMetrics","data":{"type":"object","properties":{"active":{"type":"integer"},"in_active":{"type":"integer"},"low_risk":{"type":"integer"},"high_risk":{"type":"integer"},"medium_risk":{"type":"integer"},"secure":{"type":"integer"},"low_battery":{"type":"integer"},"under_provisioning":{"type":"integer"},"recently_added":{"type":"integer"},"unspecified":{"type":"integer"},"total_devices_under_risk":{"type":"integer"}}}},"components/schemas/DeviceStatusReport":{"id":"components/schemas/DeviceStatusReport","kind":"json-schema","title":"DeviceStatusReport","data":{"type":"object","properties":{"device_id":{"type":"string","format":"uuid"},"device_name":{"type":"string"},"alias_name":{"type":"string","nullable":true},"device_model":{"type":"string"},"device_brand":{"type":"string"},"android_version":{"type":"string"},"serial_number":{"type":"string"},"is_new":{"type":"boolean"},"last_known_location":{"type":"string"},"days_active":{"type":"integer"},"status":{"type":"string","description":"choices- ACTIVE / INACTIVE / DISABLED"},"inactive_since_three_days":{"type":"boolean"}}}},"components/schemas/GroupReport":{"id":"components/schemas/GroupReport","kind":"json-schema","title":"GroupReport","data":{"type":"object","properties":{"group_id":{"type":"string","format":"uuid"},"group_name":{"type":"string"},"group_path":{"type":"string"},"active_devices":{"type":"integer"},"inactive_devices":{"type":"integer"},"registered_devices":{"type":"integer"},"new_devices":{"type":"integer"},"disabled_devices":{"type":"integer"}}}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","properties":{"id":{"type":"integer"},"email_ids":{"type":"array","items":{"type":"string","format":"email"}},"is_subscribed":{"type":"boolean"},"created_on":{"type":"string","format":"date-time"},"updated_on":{"type":"string","format":"date-time"}}}},"components/schemas/StatusMetricsV2":{"id":"components/schemas/StatusMetricsV2","kind":"json-schema","title":"StatusMetricsV2","data":{"type":"object","properties":{"last_seen":{"type":"object","properties":{"less_than_30_minutes":{"type":"integer"},"less_than_1_day":{"type":"integer"},"greater_than_1_day":{"type":"integer"}}},"low_risk":{"type":"integer"},"high_risk":{"type":"integer"},"medium_risk":{"type":"integer"},"secure":{"type":"integer"},"low_battery":{"type":"integer"},"under_provisioning":{"type":"integer"},"recently_added":{"type":"integer"},"unspecified":{"type":"integer"},"total_devices_under_risk":{"type":"integer"}}}},"components/schemas/TokenRenewV0":{"id":"components/schemas/TokenRenewV0","kind":"json-schema","title":"TokenRenewV0","data":{"type":"object","properties":{"id":{"title":"Token id","type":"string","description":"Id of the token","format":"integer","readOnly":true},"user":{"title":"User id","type":"string","description":"Id of the user resource","readOnly":true},"enterprise":{"title":"Enterprise id","type":"string","description":"Id of the enterprise resource","format":"uuid","readOnly":true},"token":{"title":"API Token","type":"string","description":"API token for accessing esper APIs","readOnly":true},"expires_at":{"title":"API token expiry","type":"string","description":"Date and time of when your API token will get expired","format":"date-time","readOnly":true},"developerapp":{"title":"Developer app id","type":"string","description":"Id of the developer app resource that you created using the esper dev console","format":"uuid","readOnly":true},"scope":{"title":"Scope of API token","type":"string","description":"This defines what access scopes your API token has","readOnly":true},"created_on":{"title":"Created on","type":"string","description":"Date and time of when this resource was created","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","description":"Date and time of when this resource was updated","format":"date-time","readOnly":true}}}},"components/schemas/V0CommandStatus":{"id":"components/schemas/V0CommandStatus","kind":"json-schema","title":"V0CommandStatus","data":{"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Unique command identifier","format":"uuid","readOnly":true},"request":{"title":"Request Id","type":"string","description":"Request Id associated with this command","format":"uuid","readOnly":true},"command":{"title":"info about the command","type":"string"},"command_args":{"type":"object","description":"arguments in command"},"issued_by":{"type":"object","properties":{"id":{"type":"integer"},"username":{"type":"string"}}},"device":{"title":"AndroidDevice","type":"string","description":"Device associated with this command","format":"url","readOnly":true},"state":{"type":"string","description":"Current state of the command","enum":["Command Queued","Command Initiated","Command Acknowledged","Command In Progress","Command TimeOut","Command Success","Command Failure","Command Scheduled","Command Cancelled"]},"reason":{"type":"string","description":"details briefing the reason for current command state"},"requeue_value":{"type":"integer","description":"indicates the command's requeue count for the device, which is limited to a maximum of 3 retries."},"created_on":{"title":"Created on","type":"string","description":"Timestamp of command creation","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","description":"Last updated timestamp of command","format":"date-time","readOnly":true}}}},"components/schemas/Geofence":{"id":"components/schemas/Geofence","kind":"json-schema","title":"Geofence","data":{"required":["latitude","longitude","name"],"type":"object","properties":{"id":{"title":"Geofence id","type":"string","description":"id of the geofence","format":"uuid","readOnly":true},"name":{"title":"Geofence name","type":"string","description":"Name of the geofence"},"description":{"title":"Geofence description","type":"string","description":"A description about the geofence"},"enterprise":{"title":"Enterprise id","type":"string","description":"id of the enterprise resource","format":"uuid","readOnly":true},"latitude":{"title":"Geofence latitude","type":"string","description":"Latitude corresponding to the geofence","format":"decimal"},"longitude":{"title":"Geofence longitude","type":"string","description":"Longitude corresponding to the geofence","format":"decimal"},"radius":{"title":"Geofence radius","type":"integer","description":"The radius within which the geofence should be applied"},"radius_unit":{"title":"Unit of radius","type":"string","description":"The unit in which the radius is taken, eg - kilometers, meters etc","enum":["KILOMETERS","METERS","MILES"]},"device_actions":{"title":"Device Actions","type":"array","description":"The actions to be performed on the device","items":{"type":"string","enum":["LOCK_DOWN","BEEP"]}},"device_count":{"title":"Device count","type":"integer","description":"Number of devices","readOnly":true},"created_by":{"title":"Created by","type":"string","description":"The user who created the geofence","readOnly":true},"created_on":{"title":"Creation date and time","type":"string","description":"Date and time of when the geofence was created","format":"date-time","readOnly":true},"updated_on":{"title":"Updation date and time","type":"string","description":"Date and time of when the geofence was updated","format":"date-time","readOnly":true}}}},"components/schemas/GeofenceUpdate":{"id":"components/schemas/GeofenceUpdate","kind":"json-schema","title":"GeofenceUpdate","data":{"type":"object","properties":{"name":{"title":"Geofence name","type":"string","description":"Name of the geofence"},"description":{"title":"Geofence description","type":"string","description":"A description about the geofence"},"latitude":{"title":"Geofence latitude","type":"string","description":"Latitude corresponding to the geofence","format":"decimal"},"longitude":{"title":"Geofence longitude","type":"string","description":"Longitude corresponding to the geofence","format":"decimal"},"radius":{"title":"Geofence radius","type":"integer","description":"The radius within which the geofence should be applied"},"radius_unit":{"title":"Unit of radius","type":"string","description":"The unit in which the radius is taken, eg - kilometers, meters etc","enum":["KILOMETERS","METERS","MILES"]},"device_actions":{"title":"Device Actions","type":"array","description":"The actions to be performed on the device","items":{"type":"string","enum":["LOCK_DOWN","BEEP"]}}}}},"components/schemas/GeofenceCreate":{"id":"components/schemas/GeofenceCreate","kind":"json-schema","title":"GeofenceCreate","data":{"type":"object","properties":{"name":{"title":"Geofence name","type":"string","description":"Name of the geofence"},"description":{"title":"Geofence description","type":"string","description":"A description about the geofence"},"latitude":{"title":"Geofence latitude","type":"string","description":"Latitude corresponding to the geofence","format":"decimal"},"longitude":{"title":"Geofence longitude","type":"string","description":"Longitude corresponding to the geofence","format":"decimal"},"radius":{"title":"Geofence radius","type":"integer","description":"The radius within which the geofence should be applied"},"radius_unit":{"title":"Unit of radius","type":"string","description":"The unit in which the radius is taken, eg - kilometers, meters etc","enum":["KILOMETERS","METERS","MILES"]},"device_actions":{"title":"Device Actions","type":"array","description":"The actions to be performed on the device","items":{"type":"string","enum":["LOCK_DOWN","BEEP"]}},"devices":{"title":"List of device ids","type":"array","description":"List of ids of devices on which the geofence is to be applied","items":{"type":"string"}}}}},"components/schemas/EnterpriseV1":{"id":"components/schemas/EnterpriseV1","kind":"json-schema","title":"EnterpriseV1","data":{"required":["id","name","short_code"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Id of the enterprise","format":"uuid","readOnly":true},"name":{"title":"Name","maxLength":255,"minLength":1,"type":"string","description":"Name of the enterprise"},"short_code":{"title":"Short code","maxLength":10,"minLength":1,"type":"string","description":"A short 10-char representation of the enterprise, separated by hyphens. Field is optional, as system will auto-generate a value if none is provided.","readOnly":true},"registered_name":{"title":"Registered name of the enterprise","maxLength":255,"minLength":1,"type":"string","description":"Registered Name of the enterprise"},"registered_address":{"title":"Registered address","maxLength":255,"minLength":1,"type":"string","description":"Registered address of the enterprise."},"location":{"title":"Enterprise location","maxLength":255,"minLength":1,"type":"string","description":"City, State, Country location of the enterprise"},"zipcode":{"title":"Enterprise zipcode","maxLength":8,"minLength":1,"type":"string","description":"Zip code of enterprise location"},"contact_person":{"title":"Contact person","maxLength":255,"minLength":1,"type":"string","description":"Person who is the point of contact for the enterprise","nullable":true},"contact_number":{"title":"Contact number","maxLength":20,"minLength":1,"type":"string","description":"Contact number of the enterprise","nullable":true},"contact_email":{"title":"Contact email","maxLength":254,"minLength":1,"type":"string","description":"Contact email address of the enterprise","format":"email"},"wifi_lte_toggle_flag":{"title":"Enable data saver mode","type":"boolean","description":"Will only be available if feature is enabled"},"emm":{"title":"Google EMM","type":"object","properties":{"google_enterprise_id":{"type":"string"}},"description":"This field will have details about emm enrollment if the enterprise is emm enrolled","nullable":true,"readOnly":true},"created_on":{"title":"Created on","type":"string","description":"Date and time of when this resource was created","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","description":"Date and time of when this resource was updated","format":"date-time","readOnly":true}}}},"components/schemas/EnterpriseUpdateV1":{"id":"components/schemas/EnterpriseUpdateV1","kind":"json-schema","title":"EnterpriseUpdateV1","data":{"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Id of the enterprise","format":"uuid","readOnly":true},"name":{"title":"Enterprise Name","maxLength":255,"minLength":1,"type":"string","description":"Name of the enterprise"},"registered_name":{"title":"Registered name","maxLength":255,"minLength":1,"type":"string","description":"Registered Name of the enterprise"},"registered_address":{"title":"Registered address","maxLength":255,"minLength":1,"type":"string","description":"Registered address of the enterprise."},"location":{"title":"Enterprise location","maxLength":255,"minLength":1,"type":"string","description":"City, State, Country location of the enterprise"},"zipcode":{"title":"Enterprise zipcode","maxLength":8,"minLength":1,"type":"string","description":"Description of the enterprise"},"contact_person":{"title":"Contact person","maxLength":255,"minLength":1,"type":"string","description":"Person who is the point of contact for the enterprise","nullable":true},"contact_number":{"title":"Contact number","maxLength":20,"minLength":1,"type":"string","description":"Contact number of the enterprise","nullable":true},"contact_email":{"title":"Contact email","maxLength":254,"minLength":1,"type":"string","description":"Contact email address of the enterprise","format":"email"},"wifi_lte_toggle_flag":{"title":"Enable data saver mode","type":"boolean","description":"Will only be available if feature is enabled"}}}},"components/schemas/ApplicationVersionV1":{"id":"components/schemas/ApplicationVersionV1","kind":"json-schema","title":"Application Version V1","data":{"title":"Application Version V1","type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"version_code":{"title":"Version code","maxLength":50,"minLength":1,"type":"string"},"build_number":{"title":"Build number","maxLength":100,"minLength":1,"type":"string","nullable":true},"hash_string":{"title":"Hash string","type":"string"},"min_sdk_version":{"title":"Min sdk version","maxLength":10,"minLength":1,"type":"string","nullable":true},"target_sdk_version":{"title":"Target sdk version","maxLength":10,"minLength":1,"type":"string","nullable":true},"icon_url":{"title":"Url for the icon","type":"string","format":"url"},"release_name":{"title":"Name of the release","type":"string"}}}},"components/schemas/ApplicationV1":{"id":"components/schemas/ApplicationV1","kind":"json-schema","title":"ApplicationV1","data":{"required":["application_name","enterprise","package_name"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"latest_version":{"$ref":"#/components/schemas/ApplicationVersionV1"},"application_name":{"title":"Application name","maxLength":255,"minLength":1,"type":"string"},"package_name":{"title":"Package name","maxLength":255,"minLength":1,"type":"string","readOnly":true},"is_hidden":{"title":"Is hidden","type":"boolean"},"enterprise":{"title":"Enterprise","type":"string","format":"url"}}}},"components/schemas/AppVersionV1":{"id":"components/schemas/AppVersionV1","kind":"json-schema","title":"Application Version V1","data":{"title":"Application Version V1","required":["enterprise","version_code"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid","readOnly":true},"installed_count":{"title":"Installed count","type":"integer","readOnly":true},"is_g_play":{"title":"Is google play","type":"boolean"},"app_file":{"title":"App file url","type":"string","format":"url","nullable":true},"app_icon":{"title":"App icon url","type":"string","format":"url","nullable":true},"version_code":{"title":"Version code","maxLength":50,"minLength":1,"type":"string","nullable":true},"build_number":{"title":"Build number","maxLength":100,"minLength":1,"type":"string","nullable":true},"min_sdk_version":{"title":"Minimum sdk version","maxLength":10,"minLength":1,"type":"string","nullable":true},"enterprise":{"title":"Enterprise URL","type":"string","format":"url"},"application":{"title":"Application URL","type":"string","format":"url"},"release_name":{"title":"Name of the release","maxLength":255,"type":"string","nullable":true},"release_comments":{"title":"Release comments","type":"string","nullable":true},"approval_status":{"title":"Approval Status","maxLength":50,"type":"string","default":"APPROVED","enum":["AVAILABLE","ACCEPTED","APPROVED","REJECTED"]},"release_date":{"title":"Release date","type":"string","format":"date-time"},"size_in_mb":{"title":"Size in mb","type":"number"},"is_default":{"title":"Is default","type":"boolean","default":false},"created_on":{"title":"Created on","type":"string","format":"date-time","readOnly":true}}}},"components/schemas/TokenInfoV1":{"id":"components/schemas/TokenInfoV1","kind":"json-schema","title":"TokenInfoV1","data":{"required":["enterprise","id"],"type":"object","properties":{"id":{"title":"Id","type":"string","description":"Token id","format":"integer","readOnly":true},"enterprise":{"title":"Enterprise id","type":"string","description":"Id of the enterprise resource","format":"uuid","readOnly":true},"user":{"title":"User id","type":"string","description":"Id of the user resource","readOnly":true},"developer_app":{"title":"Developer app id","type":"string","description":"Id of the developer app resource that you created using the esper dev console","format":"uuid","readOnly":true},"source_refresh_token":{"title":"Refresh token","type":"string","description":"The refresh token is used to refresh your expired API token","readOnly":true},"token":{"title":"API Token","type":"string","description":"API token for accessing esper APIs","readOnly":true},"expires_on":{"title":"API token expiry","type":"string","description":"Date and time of when your API token will get expired","format":"date-time","readOnly":true},"scope":{"title":"Scope of API token","type":"array","description":"This defines what access scopes does your API token has","readOnly":true,"items":{"type":"string"}},"created_on":{"title":"Created on","type":"string","description":"Date and time of when this resource was created","format":"date-time","readOnly":true},"updated_on":{"title":"Updated on","type":"string","description":"Date and time of when this resource was updated","format":"date-time","readOnly":true}}}},"components/schemas/Group":{"id":"components/schemas/Group","kind":"json-schema","title":"Group","data":{"type":"object","properties":{"id":{"title":"ID","type":"string","format":"uuid"},"name":{"title":"Group Name","type":"string"},"path":{"title":"Group Path","type":"string"},"device_count":{"type":"integer"}}}},"components/schemas/UserProfile":{"id":"components/schemas/UserProfile","kind":"json-schema","title":"UserProfileInfo","data":{"title":"UserProfileInfo","type":"object","properties":{"id":{"title":"ID","type":"integer"},"enterprise_user_id":{"title":"Enterprise User ID","type":"string"},"authn_user_id":{"title":"AuthN User ID","type":"string","format":"uuid"},"authn_connection_id":{"title":"AuthN Connection ID","type":"string","format":"uuid"},"authz_role_id":{"title":"AuthZ Role ID","type":"string","format":"uuid"},"role":{"title":"Role","type":"string","enum":["Shoonya Admin","Enterprise Admin","Enterprise User","Viewer","Group Admin","Group Viewer"]},"enterprise":{"title":"Enterprise ID","type":"string","format":"uuid"},"is_customer":{"title":"Is Customer","type":"boolean"},"is_endpoint_creator":{"title":"Is Endpoint Creator","type":"boolean"},"created_on":{"title":"Created On","type":"string","format":"date-time"},"updated_on":{"title":"Updated On","type":"string","format":"date-time"},"setup_wizard_complete":{"title":"Setup Wizard Complete","type":"boolean"},"default_password_changed":{"title":"Default Password Changed","type":"boolean"},"is_developer":{"title":"Is Developer","type":"boolean"},"can_factory_reset":{"title":"Can Factory Reset","type":"boolean"},"groups":{"title":"Groups","type":"array","items":{"type":"object","$ref":"#/components/schemas/Group"}}}}},"components/schemas/AuthenticationToken":{"id":"components/schemas/AuthenticationToken","kind":"json-schema","title":"AuthenticationToken","data":{"title":"AuthenticationToken","type":"object","properties":{"id":{"title":"ID","type":"integer"},"token":{"title":"Token","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"updated_on":{"title":"Updated On","type":"string","format":"date-time"}}}},"components/schemas/EMM":{"id":"components/schemas/EMM","kind":"json-schema","title":"UserEMM","data":{"title":"UserEMM","type":"object","properties":{"id":{"title":"ID","type":"integer"},"user":{"title":"User ID","type":"integer"},"account_identifier":{"title":"Account Identifier","type":"string"},"account_type":{"title":"Account Type","type":"string"},"display_name":{"title":"Display Name","type":"string"},"google_user_id":{"title":"Google User ID","type":"string"},"google_enterprise":{"title":"Google Enterprise","type":"integer"},"is_active":{"title":"Is Active","type":"boolean"},"created_on":{"title":"Created On","type":"string","format":"date-time"},"updated_on":{"title":"Updated On","type":"string","format":"date-time"},"authentication_token":{"title":"Authentication Token","type":"object","$ref":"#/components/schemas/AuthenticationToken","readOnly":true}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"UserInfo","data":{"title":"UserInfo","type":"object","properties":{"id":{"title":"ID","type":"integer"},"username":{"title":"User name","type":"string"},"email":{"title":"Email","type":"string","format":"email"},"first_name":{"title":"First name","type":"string"},"last_name":{"title":"Last name","type":"string"},"full_name":{"title":"Last name","type":"string"},"is_staff":{"type":"boolean","readOnly":true},"is_superuser":{"type":"boolean","readOnly":true},"is_active":{"title":"Is user active","type":"boolean"},"profile":{"title":"User Profile","type":"object","$ref":"#/components/schemas/UserProfile"},"emm":{"title":"EMM details","type":"object","$ref":"#/components/schemas/EMM","readOnly":true},"last_login":{"title":"Last login","type":"string"},"token":{"title":"Token","type":"string"},"has_emm":{"title":"Has EMM","type":"boolean"},"is_email_verified":{"title":"Is Email Verified","type":"boolean"}}}},"components/schemas/TenantUserInviteResponse":{"id":"components/schemas/TenantUserInviteResponse","kind":"json-schema","title":"TenantUserInviteResponse","data":{"title":"TenantUserInviteResponse","type":"object","properties":{"id":{"title":"id","type":"string"},"email":{"title":"email","type":"string","format":"email"},"tenant_id":{"title":"id of the tenant","type":"string"},"idp_invite_id":{"title":"id of the idp invitation","type":"string"},"meta":{"title":"meta data of user","type":"object"},"connection_id":{"title":"connection id","type":"string"},"send_invitation_email":{"title":"send invitation email","type":"boolean"},"created_at":{"title":"created at","type":"string","format":"date-time"},"updated_at":{"title":"updated at","type":"string","format":"date-time"}}}},"components/schemas/GenericErrorResponse":{"id":"components/schemas/GenericErrorResponse","kind":"json-schema","title":"GenericErrorResponse","data":{"type":"object","properties":{"status":{"type":"integer","format":"int32","description":"Either 'status' or 'code' will be present, but not both."},"code":{"type":"integer","format":"int32","description":"Either 'status' or 'code' will be present, but not both."},"error":{"type":"string","description":"Either 'error' or 'errors' will be present, but not both."},"errors":{"type":"array","items":{"type":"string"},"description":"Either 'error' or 'errors' will be present, but not both."},"message":{"title":"Message describing the error","type":"string"}}}},"components/schemas/TenantUserInviteMeta":{"id":"components/schemas/TenantUserInviteMeta","kind":"json-schema","title":"TenantUserInviteMeta","data":{"title":"TenantUserInviteMeta","type":"object","properties":{"email":{"title":"email","type":"string","format":"email"},"profile":{"title":"profile details","type":"object","properties":{"role":{"title":"role","type":"string","enum":["Enterprise Admin","Viewer","Group Admin","Group Viewer","Support","AuthZ Role User"]},"enterprise":{"title":"tenant id","type":"string","format":"uuid"},"groups":{"title":"groups associated. required only if role is Group Admin or Group Viewer or AuthZ User Role","type":"array","items":{"type":"string","format":"uuid"}},"authz_role_id":{"title":"custom role id. required only if role is AuthZ Role User","type":"string","format":"uuid"}},"required":["role","enterprise"]}},"required":["email","profile"]}},"components/schemas/TenantUserInviteRequest":{"id":"components/schemas/TenantUserInviteRequest","kind":"json-schema","title":"TenantUserInviteRequest","data":{"title":"TenantUserInviteRequest","type":"object","properties":{"email":{"title":"email","type":"string","format":"email"},"meta":{"title":"meta data of user","type":"object","$ref":"#/components/schemas/TenantUserInviteMeta"},"connection_id":{"title":"connection id","type":"string"}},"required":["email","meta"]}},"components/schemas/TenantUserInviteCreateResponse":{"id":"components/schemas/TenantUserInviteCreateResponse","kind":"json-schema","title":"TenantUserInviteResponse","data":{"title":"TenantUserInviteResponse","type":"object","properties":{"id":{"title":"id","type":"string"},"email":{"title":"email","type":"string","format":"email"},"tenant_id":{"title":"id of the tenant","type":"string"},"idp_invite_id":{"title":"id of the idp invitation","type":"string"},"meta":{"title":"meta data of user","type":"object"},"connection_id":{"title":"connection id","type":"string"},"send_invitation_email":{"title":"send invitation email","type":"boolean"},"invitation_url":{"title":"invitation URL","type":"string"},"created_at":{"title":"created at","type":"string","format":"date-time"},"updated_at":{"title":"updated at","type":"string","format":"date-time"}}}},"components/schemas/UserList":{"id":"components/schemas/UserList","kind":"json-schema","title":"User","data":{"title":"User","type":"object","properties":{"id":{"title":"ID","type":"integer"},"username":{"title":"User name","type":"string"},"email":{"title":"Email","type":"string","format":"email"},"first_name":{"title":"First name","type":"string"},"last_name":{"title":"Last name","type":"string"},"full_name":{"title":"Last name","type":"string"},"is_staff":{"type":"boolean","readOnly":true},"is_superuser":{"type":"boolean","readOnly":true},"is_active":{"title":"Is user active","type":"boolean"},"profile":{"title":"User Profile","type":"object","$ref":"#/components/schemas/UserProfile"},"emm":{"title":"EMM details","type":"object","$ref":"#/components/schemas/EMM","readOnly":true},"last_login":{"title":"Last login","type":"string"},"token":{"title":"Token","type":"string"},"has_emm":{"title":"Has EMM","type":"boolean"}}}},"components/schemas/UserProfileCreate":{"id":"components/schemas/UserProfileCreate","kind":"json-schema","title":"UserProfile","data":{"title":"UserProfile","type":"object","properties":{"role":{"title":"Role","type":"string","enum":["Shoonya Admin","Enterprise Admin","Enterprise User","Viewer","Group Admin","Group Viewer"]},"groups":{"title":"Groups","type":"array","items":{"type":"string"}},"enterprise":{"title":"Enterprise ID","type":"string","format":"uuid"},"is_customer":{"title":"Is Customer","type":"boolean"},"is_endpoint_creator":{"title":"Is Endpoint Creator","type":"boolean"},"setup_wizard_complete":{"title":"Setup Wizard Complete","type":"boolean"},"default_password_changed":{"title":"Default Password Changed","type":"boolean"},"is_developer":{"title":"Is Developer","type":"boolean"},"can_factory_reset":{"title":"Can Factory Reset","type":"boolean"}}}},"components/schemas/UserCreate":{"id":"components/schemas/UserCreate","kind":"json-schema","title":"UserCreate","data":{"required":["username","profile"],"title":"UserCreate","type":"object","properties":{"username":{"title":"User name","type":"string"},"password":{"title":"Password","type":"string"},"first_name":{"title":"First name","type":"string"},"last_name":{"title":"Last name","type":"string"},"is_active":{"title":"Is user active","type":"boolean"},"email":{"title":"Email","type":"string","format":"email"},"profile":{"title":"User Profile","type":"object","$ref":"#/components/schemas/UserProfileCreate"}}}},"components/schemas/UserUpdate":{"id":"components/schemas/UserUpdate","kind":"json-schema","title":"UserUpdation","data":{"title":"UserUpdation","type":"object","properties":{"username":{"title":"User name","type":"string"},"password":{"title":"Password","type":"string"},"first_name":{"title":"First name","type":"string"},"last_name":{"title":"Last name","type":"string"},"is_active":{"title":"Is user active","type":"boolean"},"email":{"title":"Email","type":"string","format":"email"},"profile":{"title":"User Profile","type":"object","$ref":"#/components/schemas/UserProfileCreate"}}}},"components/schemas/UpdateDifferentUserRequest":{"id":"components/schemas/UpdateDifferentUserRequest","kind":"json-schema","title":"UpdateDifferentUserRequest","data":{"type":"object","properties":{"authz_role_id":{"title":"Custom role id. Required only if role is AuthZ Role User","type":"string","format":"uuid"},"can_factory_reset":{"title":"If user should be able to factory reset or not","type":"boolean"},"has_all_group_access":{"title":"If user has access to all groups or not. Required only if role is AuthZ Role User","type":"boolean"},"groups":{"title":"List of group IDs. Can be empty if has_all_group_access is True or if the user role is not Group Admin/Group Viewer","type":"array","items":{"type":"string"}},"role":{"title":"Role. Role should be AuthZ Role User for custom role","type":"string","enum":["Shoonya Admin","Enterprise Admin","Enterprise User","Viewer","Group Admin","Group Viewer","AuthZ Role User"]}},"required":["role","groups"]}},"components/schemas/UpdateOwnUserRequest":{"id":"components/schemas/UpdateOwnUserRequest","kind":"json-schema","title":"UpdateOwnUserRequest","data":{"type":"object","properties":{"first_name":{"title":"first name","type":"string"}},"required":["first_name"]}},"components/schemas/UserGroups":{"id":"components/schemas/UserGroups","kind":"json-schema","title":"UserGroups","data":{"type":"object","properties":{"group_ids":{"type":"array","items":{"type":"string","format":"uuid"}},"has_all_group_access":{"type":"boolean"}}}},"components/schemas/ConnectivitySection":{"id":"components/schemas/ConnectivitySection","kind":"json-schema","title":"Connectivity","data":{"title":"Connectivity","type":"object","properties":{"sms_disabled":{"type":"boolean"},"enable_bluetooth":{"type":"boolean"},"wifi_state":{"type":"boolean"},"nfc_beam_disabled":{"type":"boolean"},"ethernet_settings":{"type":"object","description":"Ethernet settings to configure ethernet certificate","required":["ethernet_auth_mode"],"properties":{"ethernet_auth_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth Mode options"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* EAP_TLS: Ethernet auth mode is EAP_TLS\n* NONE: Default Value, if NONE then other fields are option\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* EAP_TLS: Ethernet auth mode is EAP_TLS\n* NONE: Default Value, if NONE then other fields are option\n"},"children":[]}]}],"enum":["EAP_TLS","NONE"]},"ethernet_ca_cert_alias":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is mandatory field if Auth Mode is “EAP_TLS”."},"children":[]}]}]}]},"ethernet_client_cert_alias":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is mandatory field if Auth Mode is “EAP_TLS”."},"children":[]}]}]}]},"ethernet_eap_identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is mandatory field if Auth Mode is “EAP_TLS”."},"children":[]}]}]}]}}},"wifi_settings":{"type":"array","items":{"type":"object","properties":{"wifi_ssid":{"type":"string"},"wifi_password":{"type":"string"},"wifi_security_type":{"type":"string","enum":["NONE","WAP","WEP","EAP","WPA2","SAE"]},"wifi_phase2_auth":{"type":"string","enum":["NONE","PAP","MSCHAP","MSCHAPV2","GTC","SIM","AKA","AKA_PRIME"]},"wifi_eap_method":{"type":"string","enum":["PEAP","TLS","TTLS","PWD","NONE","SIM","AKA","AKA_PRIME"]},"identity":{"type":"string"},"anonymous_identity":{"type":"string"},"domain":{"type":"string"},"hidden":{"type":"boolean"}}}},"incoming_numbers_with_tags":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"outgoing_numbers_with_tags":{"type":"array","items":{"type":"object","properties":{"number":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/SoundSection":{"id":"components/schemas/SoundSection","kind":"json-schema","title":"Sound","data":{"title":"Sound","type":"object","properties":{"alarm_volume":{"type":"integer"},"notification_volume":{"type":"integer"},"music_volume":{"type":"integer"},"ring_volume":{"type":"integer"},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/DisplayBrandingSection":{"id":"components/schemas/DisplayBrandingSection","kind":"json-schema","title":"Display","data":{"title":"Display","type":"object","properties":{"screenshot_disabled":{"type":"boolean"},"status_bar_disabled":{"type":"boolean"},"rotation_state":{"type":"string","enum":["AUTO","LANDSCAPE_ONLY","POTRAIT_ONLY","INVERTED_PORTRAIT_ONLY","INVERTED_LANDSCAPE_ONLY"]},"brightness_scale":{"type":"integer"},"wallpapers":{"type":"array","items":{"type":"object","properties":{"wallpaper":{"type":"string","format":"uuid"},"wallpaper_url":{"type":"string","readOnly":true},"thumbnail_url":{"type":"string","readOnly":true},"orientation":{"type":"string"},"screen_types":{"type":"array","items":{"type":"string","enum":["LOCKSCREEN","HOMESCREEN"]}},"orientations":{"type":"array","items":{"type":"string","enum":["PORTRAIT","LANDSCAPE"]}}}}},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/HardwareSettingsSection":{"id":"components/schemas/HardwareSettingsSection","kind":"json-schema","title":"Hardware","data":{"title":"Hardware","type":"object","properties":{"gps_state":{"type":"string","enum":["LOCATION_MODE_HIGH_ACCURACY","LOCATION_MODE_SENSORS_ONLY","LOCATION_MODE_BATTERY_SAVING","LOCATION_MODE_OFF","LOCATION_MODE_ON"]},"usb_file_transfer_disabled":{"type":"boolean"},"tethering_disabled":{"type":"boolean"},"camera_disabled":{"type":"boolean"},"usb_connectivity_disabled":{"type":"boolean"},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/DateTimeSection":{"id":"components/schemas/DateTimeSection","kind":"json-schema","title":"Date Time","data":{"title":"Date Time","type":"object","properties":{"timezone_string":{"type":"string"},"device_locale":{"type":"string"},"date_time_config_disabled":{"type":"boolean"},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/SettingsAppSection":{"id":"components/schemas/SettingsAppSection","kind":"json-schema","title":"Settings App","data":{"title":"Settings App","type":"object","properties":{"enable_android_settings_app":{"type":"boolean"},"settings_access_level":{"type":"string","enum":["NONE","SHOONYA","SYSTEM"]},"esper_settings_app":{"type":"object","properties":{"only_dock_accessible":{"type":"boolean"},"admin_mode_password":{"type":"string"},"esper_settings_app_policy":{"type":"object","properties":{"flashlight":{"type":"string"},"wifi":{"type":"string"},"auto_rotation":{"type":"string"},"reboot":{"type":"string"},"kiosk_app_selection":{"type":"string"},"esper_branding":{"type":"string"},"factory_reset":{"type":"string"},"about":{"type":"string"},"display":{"type":"string"},"sound":{"type":"string"},"keyboard":{"type":"string"},"input_selection":{"type":"string"},"accessibility":{"type":"string"},"mobile_data":{"type":"string"},"bluetooth":{"type":"string"},"language":{"type":"string"},"time_and_date":{"type":"string"},"clear_app_data":{"type":"string"},"storage":{"type":"string"},"data_roaming":{"type":"string"},"wifi_tethering":{"type":"string"},"airplane_mode":{"type":"string"},"accessibility_reset_to_default":{"type":"string"},"accessibility_high_contrast_text":{"type":"string"},"accessibility_cc_deuteranomaly":{"type":"string"},"accessibility_cc_protanomaly":{"type":"string"},"accessibility_cc_tritanomaly":{"type":"string"},"accessibility_mono_audio":{"type":"string"},"accessibility_display_size":{"type":"string"},"accessibility_talkback":{"type":"string"},"accessibility_text_to_speech":{"type":"string"}}}}},"config_json":{"type":"object"},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/SystemUpdatesSection":{"id":"components/schemas/SystemUpdatesSection","kind":"json-schema","title":"System Updates","data":{"title":"System Updates","type":"object","properties":{"locked":{"title":"Locked","description":"Locked","type":"boolean"},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"type":{"title":"Type","description":"Type","type":"string","enum":["TYPE_POSTPONE","TYPE_INSTALL_AUTOMATIC","TYPE_INSTALL_WINDOWED","TYPE_INSTALL_DISABLED"]},"maintenance_start":{"type":"integer"},"maintenance_end":{"type":"integer"}}}},"components/schemas/GoogleServicesSection":{"id":"components/schemas/GoogleServicesSection","kind":"json-schema","title":"Google Services","data":{"title":"Google Services","type":"object","properties":{"disable_play_store":{"type":"boolean"},"google_assistant_disabled":{"type":"boolean"},"managed_google_play_disabled":{"type":"boolean"},"max_account":{"type":"integer"},"emails":{"type":"array","items":{"type":"string"}},"domains":{"type":"array","items":{"type":"string"}},"frp_googles":{"type":"array","items":{"type":"object","properties":{"google_id":{"type":"string"},"email":{"type":"string"},"type":{"type":"string","enum":["USER","ADMIN"]}}}},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/SecuritySection":{"id":"components/schemas/SecuritySection","kind":"json-schema","title":"Security","data":{"title":"Security","type":"object","properties":{"password_quality":{"type":"string","enum":["PASSWORD_QUALITY_ALPHABETIC","PASSWORD_QUALITY_ALPHANUMERIC","PASSWORD_QUALITY_UNSPECIFIED","PASSWORD_QUALITY_COMPLEX","PASSWORD_QUALITY_BIOMETRIC_WEAK","PASSWORD_QUALITY_NUMERIC"]},"minimum_password_length":{"type":"integer"},"adb_disabled":{"type":"boolean"},"safe_boot_disabled":{"type":"boolean"},"screen_off_timeout":{"type":"integer"},"factory_reset_disabled":{"type":"boolean"},"keyguard_disabled":{"type":"boolean"},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"}}}},"components/schemas/ApplicationSection":{"id":"components/schemas/ApplicationSection","kind":"json-schema","title":"Application","data":{"title":"Application","type":"object","properties":{"app_mode":{"type":"string","enum":["KIOSK","MULTI_APP"]},"launch_on_start":{"type":"string"},"start_on_boot":{"type":"string","nullable":true},"launcher_less_dpc":{"type":"boolean"},"disable_local_app_install":{"type":"boolean"},"app_uninstall_disabled":{"type":"boolean"},"permission_policy":{"type":"string","enum":["PERMISSION_POLICY_AUTO_GRANT","PERMISSION_POLICY_PROMPT","PERMISSION_POLICY_AUTO_DENY"]},"locked":{"title":"Locked","description":"Locked","type":"boolean"},"preload_apps":{"type":"array","items":{"type":"object","properties":{"package_name":{"type":"string"},"state":{"type":"string","enum":["SHOW","HIDE","DISABLED","LAUNCHABLE_BUT_HIDDEN"]}}}},"apps":{"type":"array","items":{"type":"object","properties":{"version_codes":{"type":"array","items":{"type":"string"},"readOnly":true},"is_g_play":{"type":"boolean","readOnly":true},"app_version":{"type":"string","format":"uuid"},"app_version_url":{"type":"string","readOnly":true},"hash_string":{"type":"string","readOnly":true},"package_name":{"type":"string","readOnly":true},"download_url":{"type":"string","readOnly":true},"installation_rule":{"type":"string","enum":["DURING","POST"]},"state":{"type":"string","enum":["SHOW","HIDE","DISABLED","LAUNCHABLE_BUT_HIDDEN"]},"managed_config":{"type":"object"}}}},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]}}}},"components/schemas/ContentSection":{"id":"components/schemas/ContentSection","kind":"json-schema","title":"Content","data":{"title":"Content","type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"file":{"type":"integer"},"file_url":{"type":"string","readOnly":true},"hash":{"type":"string","readOnly":true},"url":{"type":"string","readOnly":true},"destination_path":{"type":"string"}}}},"section_type":{"title":"Type","type":"string","enum":["Inherited","Independent"]},"locked":{"type":"boolean"}}}},"components/schemas/BlueprintRevision":{"id":"components/schemas/BlueprintRevision","kind":"json-schema","title":"Blueprint","data":{"title":"Blueprint","type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"revision":{"type":"string","readOnly":true},"created_by":{"type":"string","readOnly":true},"current":{"type":"boolean","readOnly":true},"type":{"type":"string","enum":["Independent","Inherited"]},"comments":{"type":"string"},"locked":{"type":"boolean"},"connectivity":{"$ref":"#/components/schemas/ConnectivitySection"},"sound":{"$ref":"#/components/schemas/SoundSection"},"display_branding":{"$ref":"#/components/schemas/DisplayBrandingSection"},"hardware_settings":{"$ref":"#/components/schemas/HardwareSettingsSection"},"date_time":{"$ref":"#/components/schemas/DateTimeSection"},"settings_app":{"$ref":"#/components/schemas/SettingsAppSection"},"system_updates":{"$ref":"#/components/schemas/SystemUpdatesSection"},"google_services":{"$ref":"#/components/schemas/GoogleServicesSection"},"security":{"$ref":"#/components/schemas/SecuritySection"},"application":{"$ref":"#/components/schemas/ApplicationSection"},"content":{"$ref":"#/components/schemas/ContentSection"},"created_on":{"title":"Created on","description":"Date and time of when the group was created","type":"string","format":"date-time","readOnly":true}}}},"components/schemas/Blueprint":{"id":"components/schemas/Blueprint","kind":"json-schema","title":"Blueprint","data":{"title":"Blueprint","type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"locked":{"type":"boolean"},"group":{"type":"string","format":"uuid"},"latest_revision":{"$ref":"#/components/schemas/BlueprintRevision"},"created_on":{"type":"string","format":"date-time","readOnly":true},"updated_on":{"type":"string","format":"date-time","readOnly":true}}}},"components/schemas/UniqueIdentifier":{"id":"components/schemas/UniqueIdentifier","kind":"json-schema","title":"UniqueIdentifier","data":{"title":"UniqueIdentifier","type":"object","properties":{"unique_id":{"title":"Unique identifier","type":"string"},"type":{"title":"Unique identifier type","type":"string","enum":["IMEI1","IMEI2","SERIAL","MEI","WIFI_MAC_ID","ETHERNET_MAC_ID"]}}}},"components/schemas/DirectoryRecord":{"id":"components/schemas/DirectoryRecord","kind":"json-schema","title":"DirectoryRecord","data":{"title":"DirectoryRecord","type":"object","properties":{"id":{"title":"Directory Record ID","type":"string"},"name":{"title":"Device name","type":"string"},"online_status":{"type":"string","enum":["ONLINE","OFFLINE","NONE"]},"alias":{"title":"Alias name","type":"string"},"tags":{"title":"Tags","type":"array","items":{"type":"string"}},"group_id":{"title":"Group ID","type":"string","format":"uuid"},"device_id":{"title":"Device ID","type":"string","format":"uuid"},"approval_status":{"title":"Approval Status","type":"string","enum":["WAITING_FOR_APPROVAL","APPROVED","REJECTED","BLOCKED"]},"provisioned_on":{"title":"Provisioned on","type":"string","format":"date-time","readOnly":true},"unique_identifiers":{"title":"Unique Identifiers","type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/UniqueIdentifier"}]}}}}},"components/schemas/UniqueIdentifierCreate":{"id":"components/schemas/UniqueIdentifierCreate","kind":"json-schema","title":"UniqueIdentifierCreate","data":{"title":"UniqueIdentifierCreate","type":"object","properties":{"unique_id":{"title":"Unique identifier","type":"string"},"type":{"title":"Unique identifier type","type":"integer","enum":[0,1,2,3,4,5],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following are the valid Unique Identifier Types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"IMEI1 = 0\nIMEI2 = 1\nSERIAL = 2\nMEI = 3\nWIFI_MAC_ID = 4\nETHERNET_MAC_ID = 5\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"IMEI1 = 0\nIMEI2 = 1\nSERIAL = 2\nMEI = 3\nWIFI_MAC_ID = 4\nETHERNET_MAC_ID = 5\n"},"children":[]}]}]}}}},"components/schemas/DirectoryRecordCreate":{"id":"components/schemas/DirectoryRecordCreate","kind":"json-schema","title":"DirectoryRecordCreate","data":{"title":"DirectoryRecordCreate","type":"object","properties":{"unique_identifiers":{"title":"Unique Identifiers","type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/UniqueIdentifierCreate"}]}},"group_id":{"title":"Group ID","type":"string","format":"uuid"},"alias":{"title":"Alias name","type":"string"},"tags":{"title":"Tags","type":"array","items":{"type":"string"}}}}},"components/schemas/DirectoryRecordUpdate":{"id":"components/schemas/DirectoryRecordUpdate","kind":"json-schema","title":"DirectoryRecordUpdate","data":{"title":"DirectoryRecordUpdate","type":"object","properties":{"unique_identifiers":{"title":"Unique Identifiers","type":"array","items":{"type":"object","allOf":[{"$ref":"#/components/schemas/UniqueIdentifierCreate"}]}},"group_id":{"title":"Group ID","type":"string","format":"uuid"},"alias":{"title":"Alias name","type":"string"},"tags":{"title":"Tags","type":"array","items":{"type":"string"}}}}},"components/schemas/CustomConnectionList":{"id":"components/schemas/CustomConnectionList","kind":"json-schema","title":"CustomConnectionList","data":{"title":"CustomConnectionList","type":"object","properties":{"name":{"title":"name","type":"string"},"strategy":{"title":"strategy","enum":["samlp","oidc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strategy:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"samlp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SAML connection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oidc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - OIDC connection"},"children":[]}]}]}]}]},"is_default":{"title":"is default","type":"boolean"}}}},"components/schemas/CustomConnectionsListResponse":{"id":"components/schemas/CustomConnectionsListResponse","kind":"json-schema","title":"CustomConnectionsListResponse","data":{"title":"CustomConnectionsListResponse","type":"object","properties":{"connection_id":{"title":"connection id","type":"string"},"connection":{"type":"object","$ref":"#/components/schemas/CustomConnectionList"}}}},"components/schemas/CustomConnectionConfigResponse":{"id":"components/schemas/CustomConnectionConfigResponse","kind":"json-schema","title":"CustomConnectionConfigResponse","data":{"title":"CustomConnectionConfigResponse","type":"object","properties":{"sign_in_url":{"title":"Sign in url","type":"string","format":"url","description":"Required for SAML connection"},"disable_sign_out":{"title":"Disable sign out","type":"boolean"},"sign_out_url":{"title":"Sign out url","type":"string","format":"url"},"x509_certificate":{"title":"x509 certificate","type":"string","description":"Required for SAML connection"},"issuer_url":{"title":"Issuer url","type":"string","format":"url","description":"Required for OIDC connection"},"client_id":{"title":"client id","type":"string","description":"Required for OIDC connection"}}}},"components/schemas/CustomConnectionRequest":{"id":"components/schemas/CustomConnectionRequest","kind":"json-schema","title":"CustomConnectionRequest","data":{"title":"CustomConnectionRequest","type":"object","properties":{"display_name":{"title":"display name","type":"string"},"strategy":{"title":"strategy","enum":["samlp","oidc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strategy:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"samlp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SAML connection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oidc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - OIDC connection"},"children":[]}]}]}]}]},"config":{"type":"object","$ref":"#/components/schemas/CustomConnectionConfigResponse"}}}},"components/schemas/CustomConnectionResponse":{"id":"components/schemas/CustomConnectionResponse","kind":"json-schema","title":"CustomConnectionResponse","data":{"title":"CustomConnectionResponse","type":"object","properties":{"id":{"title":"id","type":"string"},"name":{"title":"name","type":"string"},"display_name":{"title":"display name","type":"string"},"strategy":{"title":"strategy","enum":["samlp","oidc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strategy:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"samlp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - SAML connection"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oidc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - OIDC connection"},"children":[]}]}]}]}]},"service_provider_acs_url":{"title":"service provider ACS url","type":"string","format":"url"},"service_provider_entity_id":{"title":"service provider entity id","type":"string"},"service_provider_logout_url":{"title":"service provider logout url","type":"string"},"signing_certificate_link":{"title":"signing certificate link","type":"string"},"callback_url":{"title":"callback url","type":"string","format":"url"},"config":{"type":"object","$ref":"#/components/schemas/CustomConnectionConfigResponse"}}}},"components/schemas/RoleResponse":{"id":"components/schemas/RoleResponse","kind":"json-schema","title":"RoleResponse","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"role_type":{"type":"integer"}}}},"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}}},"components/schemas/ScopeResponse":{"id":"components/schemas/ScopeResponse","kind":"json-schema","title":"ScopeResponse","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"scope_type":{"type":"integer"}}}},"components/schemas/PersonalAccessTokenGetResponse":{"id":"components/schemas/PersonalAccessTokenGetResponse","kind":"json-schema","title":"PersonalAccessTokenGetResponse","data":{"title":"PersonalAccessTokenGetResponse","type":"object","properties":{"count":{"type":"integer"},"personal_access_tokens":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the token."},"name":{"type":"string","description":"The name of the token."},"description":{"type":"string","description":"A description of the token."},"created_at":{"type":"string","format":"timestamp","description":"Timestamp indicating when the token was created."},"updated_at":{"type":"string","format":"timestamp","description":"Timestamp indicating when the token was updated."},"prefix":{"type":"string","description":"The token prefix."},"token":{"type":"string","description":"The token value."},"expiry_at":{"type":"integer","description":"exipy date for token, -1 indicates no expiry."},"legacy_token_id":{"type":"integer","description":"token id corresponding to legacy system"},"legacy_developer_app_id":{"type":"string","description":"developer app id corresponding to legacy system"}}}}}}},"components/schemas/PersonalAccessTokenCreateResponse":{"id":"components/schemas/PersonalAccessTokenCreateResponse","kind":"json-schema","title":"PersonalAccessTokenCreateResponse","data":{"title":"PersonalAccessTokenCreateResponse","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique ID for the generated token."},"name":{"type":"string","description":"Name for the token."},"description":{"type":"string","description":"Description for the token."},"created_at":{"type":"string","format":"timestamp","description":"Timestamp indicating when the token was created."},"updated_at":{"type":"string","format":"timestamp","description":"Timestamp indicating when the token was last updated."},"token":{"type":"string","description":"The generated access token value."},"prefix":{"type":"string","description":"Prefix for the generated token value."},"expiry_at":{"type":"integer","description":"exipy date for token."}}}},"components/schemas/PersonalAccessTokenUpdateResponse":{"id":"components/schemas/PersonalAccessTokenUpdateResponse","kind":"json-schema","title":"PersonalAccessTokenUpdateResponse","data":{"title":"PersonalAccessTokenUpdateResponse","type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique ID for the generated token."},"name":{"type":"string","description":"Name for the token."},"description":{"type":"string","description":"Description for the token."},"created_at":{"type":"string","format":"timestamp","description":"Timestamp indicating when the token was created."},"updated_at":{"type":"string","format":"timestamp","description":"Timestamp indicating when the token was last updated."},"token":{"type":"string","description":"The generated access token value."},"prefix":{"type":"string","description":"Prefix for the generated token value."},"expiry_at":{"type":"integer","description":"exipy date for token."},"legacy_token_id":{"type":"integer","description":"token id corresponding to legacy system"},"legacy_developer_app_id":{"type":"string","description":"developer app id corresponding to legacy system"}}}},"components/schemas/UsersListResponse":{"id":"components/schemas/UsersListResponse","kind":"json-schema","title":"UsersListResponse","data":{"title":"UsersListResponse","type":"object","properties":{"user_id":{"title":"user id","type":"string"},"tenant_id":{"title":"tenant id","type":"string","format":"uuid"},"partner_id":{"title":"partner id","type":"string","format":"uuid"},"email":{"title":"email","type":"string"},"name":{"title":"name","type":"string"},"connection_id":{"title":"connection id","type":"string"},"created_at":{"title":"created_at","type":"string","format":"timestamp"},"updated_at":{"title":"updated_at","type":"string","format":"timestamp"}}}},"components/schemas/apply_policy":{"id":"components/schemas/apply_policy","kind":"json-schema","title":"apply_policy","data":{"type":"string","enum":["ALWAYS APPLY","IGNORE","PROVISION ONLY"]}},"components/schemas/device_mode_settings":{"id":"components/schemas/device_mode_settings","kind":"json-schema","title":"device_mode_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"device_mode":{"type":"string","enum":["KIOSK","MULTI APP"]}}}},"components/schemas/launcher_settings":{"id":"components/schemas/launcher_settings","kind":"json-schema","title":"launcher_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"launcher":{"type":"string","enum":["ESPER","DEFAULT"]}},"required":["apply_policy","launcher"]}},"components/schemas/local_app_install_settings":{"id":"components/schemas/local_app_install_settings","kind":"json-schema","title":"local_app_install_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_local_app_install":{"type":"boolean"}},"required":["apply_policy","allow_local_app_install"]}},"components/schemas/app_uninstall_settings":{"id":"components/schemas/app_uninstall_settings","kind":"json-schema","title":"app_uninstall_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_app_uninstallation":{"type":"boolean"}},"required":["apply_policy","allow_app_uninstallation"]}},"components/schemas/app_permission_policy_settings":{"id":"components/schemas/app_permission_policy_settings","kind":"json-schema","title":"app_permission_policy_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"permission_policy":{"type":"string","enum":["ALLOW AUTOMATICALLY","DENY","ASK USER"]}},"required":["apply_policy","permission_policy"]}},"components/schemas/wifi_settings":{"id":"components/schemas/wifi_settings","kind":"json-schema","title":"wifi_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_wifi":{"type":"boolean"},"wifi_state":{"type":"string","enum":["ENABLE","DISABLE"]}},"required":["apply_policy","allow_wifi","wifi_state"]}},"components/schemas/drift_policy":{"id":"components/schemas/drift_policy","kind":"json-schema","title":"drift_policy","data":{"type":"string","enum":["IGNORE","LOG ONLY","MINOR","MAJOR","CRITICAL"],"default":"IGNORE","description":"Allowed values: IGNORE, LOG ONLY, MINOR, MAJOR, CRITICAL"}},"components/schemas/bluetooth_settings":{"id":"components/schemas/bluetooth_settings","kind":"json-schema","title":"bluetooth_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_bluetooth":{"type":"boolean"},"bluetooth_state":{"type":"string","enum":["ENABLE","DISABLE"]},"drift_policy":{"$ref":"#/components/schemas/drift_policy"}},"required":["apply_policy","allow_bluetooth"]}},"components/schemas/sms_settings":{"id":"components/schemas/sms_settings","kind":"json-schema","title":"sms_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_sms":{"type":"boolean"}},"required":["apply_policy","allow_sms"]}},"components/schemas/nfc_settings":{"id":"components/schemas/nfc_settings","kind":"json-schema","title":"nfc_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_nfc":{"type":"boolean"}},"required":["apply_policy","allow_nfc"]}},"components/schemas/incoming_numbers_settings":{"id":"components/schemas/incoming_numbers_settings","kind":"json-schema","title":"incoming_numbers_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_all_numbers":{"type":"boolean"},"allowed_numbers":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}},"required":["apply_policy","allow_all_numbers"]}},"components/schemas/outgoing_numbers_settings":{"id":"components/schemas/outgoing_numbers_settings","kind":"json-schema","title":"outgoing_numbers_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_all_numbers":{"type":"boolean"},"allow_ussd_codes":{"type":"boolean","default":false},"allowed_numbers":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}}},"required":["apply_policy","allow_all_numbers"]}},"components/schemas/ethernet_settings":{"id":"components/schemas/ethernet_settings","kind":"json-schema","title":"ethernet_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"auth_mode":{"type":"string","enum":["NONE","EAP-TLS"]},"ca_cert_alias":{"type":"string"},"client_cert_alias":{"type":"string"},"eap_identity":{"type":"string"}},"required":["apply_policy"]}},"components/schemas/adb_settings":{"id":"components/schemas/adb_settings","kind":"json-schema","title":"adb_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_adb":{"type":"boolean"}},"required":["apply_policy","allow_adb"]}},"components/schemas/safe_boot_settings":{"id":"components/schemas/safe_boot_settings","kind":"json-schema","title":"safe_boot_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_safe_boot":{"type":"boolean"}},"required":["apply_policy","allow_safe_boot"]}},"components/schemas/factory_reset_settings":{"id":"components/schemas/factory_reset_settings","kind":"json-schema","title":"factory_reset_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_factory_reset":{"type":"boolean"}},"required":["apply_policy","allow_factory_reset"]}},"components/schemas/screen_timeout_settings":{"id":"components/schemas/screen_timeout_settings","kind":"json-schema","title":"screen_timeout_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"screentimeout_value":{"type":"integer"}},"required":["apply_policy","screentimeout_value"]}},"components/schemas/lock_screen_settings":{"id":"components/schemas/lock_screen_settings","kind":"json-schema","title":"lock_screen_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"password_quality":{"type":"string","enum":["NONE","ALPHABETIC","NUMERIC","ALPHANUMERIC","COMPLEX","BIOMETRIC_WEAK"]},"minimum_password_length":{"type":"integer","nullable":true},"allow_keyguard":{"type":"boolean"}},"required":["apply_policy","password_quality","allow_keyguard"]}},"components/schemas/brightness_settings":{"id":"components/schemas/brightness_settings","kind":"json-schema","title":"brightness_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"brightness_value":{"type":"string"}}}},"components/schemas/screen_orientation_settings":{"id":"components/schemas/screen_orientation_settings","kind":"json-schema","title":"screen_orientation_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"orientation_type":{"type":"string","enum":["PORTRAIT","LANDSCAPE","INVERTED PORTRAIT","INVERTED LANDSCAPE","AUTO"]}}}},"components/schemas/screenshot_settings":{"id":"components/schemas/screenshot_settings","kind":"json-schema","title":"screenshot_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_screenshot":{"type":"boolean"}}}},"components/schemas/notification_bar_settings":{"id":"components/schemas/notification_bar_settings","kind":"json-schema","title":"notification_bar_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_notification_bar":{"type":"boolean"}}}},"components/schemas/wallpaper_settings":{"id":"components/schemas/wallpaper_settings","kind":"json-schema","title":"wallpaper_settings","data":{"type":"object","properties":{"homescreen":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"portrait":{"type":"object","properties":{"wallpaper_id":{"type":"string"}}},"landscape":{"type":"object","properties":{"wallpaper_id":{"type":"string"}}}}},"lockscreen":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"portrait":{"type":"object","properties":{"wallpaper_id":{"type":"string"}}}}}}}},"components/schemas/esper_settings_apps_settings":{"id":"components/schemas/esper_settings_apps_settings","kind":"json-schema","title":"esper_settings_apps_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_dock":{"type":"boolean"},"admin_mode_password":{"type":"string"},"allow_esper_settings_app":{"type":"boolean"},"settings":{"type":"object","properties":{"flashlight":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"wifi":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"auto_rotation":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"reboot":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"clear_app_data":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"kiosk_app_selection":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"esper_branding":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"factory_reset":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"about":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"display":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"sound":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"keyboard":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"input_selection":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_reset_to_default":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_high_contrast_text":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_cc_deuteranomaly":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_cc_protanomaly":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_cc_tritanomaly":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_mono_audio":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_display_size":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_font_scale":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_talkback":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"accessibility_text_to_speech":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"mobile_data":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"bluetooth":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"language":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"time_and_date":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"storage":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"data_roaming":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"wifi_tethering":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]},"airplane_mode":{"type":"string","enum":["NONE","USER","ADMIN","BOTH"]}}}},"required":["dock_accessibitly_settings","admin_mode_password_settings","settings"]}},"components/schemas/android_settings_app_settings":{"id":"components/schemas/android_settings_app_settings","kind":"json-schema","title":"android_settings_app_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_android_settings_app":{"type":"boolean"}},"required":["allow_android_settings_app"]}},"components/schemas/customized_device_level_json_settings":{"id":"components/schemas/customized_device_level_json_settings","kind":"json-schema","title":"customized_device_level_json_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"customized_json":{"type":"object"}},"required":["customized_json"]}},"components/schemas/google_services_settings":{"id":"components/schemas/google_services_settings","kind":"json-schema","title":"google_services_settings","data":{"type":"object","properties":{"afw_account_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_afw_account_addition":{"type":"boolean"}},"required":["apply_policy","allow_afw_account_addition"]},"personal_accounts_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"personal_accounts_limit_value":{"type":"integer"}},"required":["apply_policy","personal_accounts_limit_value"]},"play_store_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_playstore":{"type":"boolean"}},"required":["apply_policy","allow_playstore"]},"google_assitant_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_google_assistant":{"type":"boolean"}},"required":["apply_policy","allow_google_assistant"]},"factory_reset_protection_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"google_id":{"type":"string"},"email":{"type":"string"}},"required":["apply_policy","google_id","email"]}},"required":["afw_account_settings","personal_accounts_settings","play_store_settings","google_assitant_settings","factory_reset_protection_settings"]}},"components/schemas/external_device_settings":{"id":"components/schemas/external_device_settings","kind":"json-schema","title":"external_device_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_external_device_mount":{"type":"boolean"}}}},"components/schemas/usb_tethering_settings":{"id":"components/schemas/usb_tethering_settings","kind":"json-schema","title":"usb_tethering_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_usb_tethering":{"type":"boolean"}}}},"components/schemas/file_transfer_settings":{"id":"components/schemas/file_transfer_settings","kind":"json-schema","title":"file_transfer_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_file_transfer":{"type":"boolean"}}}},"components/schemas/camera_settings":{"id":"components/schemas/camera_settings","kind":"json-schema","title":"camera_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_camera_access":{"type":"boolean"}}}},"components/schemas/location_settings":{"id":"components/schemas/location_settings","kind":"json-schema","title":"location_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_location":{"type":"boolean"}}}},"components/schemas/sound_settings":{"id":"components/schemas/sound_settings","kind":"json-schema","title":"sound_settings","data":{"type":"object","properties":{"alarm_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"alarm_volume":{"type":"integer"}}},"music_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"music_volume":{"type":"integer"}}},"ringtone_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"ringtone_volume":{"type":"integer"}}},"notification_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"notification_volume":{"type":"integer"}}},"voice_call_settings":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"voice_call_volume":{"type":"integer"}}}}}},"components/schemas/system_updates_settings":{"id":"components/schemas/system_updates_settings","kind":"json-schema","title":"system_updates_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"system_update_policy_type":{"type":"string","enum":["UPDATE AUTOMATICALLY","POSTPONE INSTALLATION","WINDOWED INSTALLATION","DISABLE UPDATE","DEFAULT UPDATE"]},"maintenance_start":{"type":"string"},"maintenance_end":{"type":"string"}}}},"components/schemas/time_date_settings":{"id":"components/schemas/time_date_settings","kind":"json-schema","title":"time_date_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_edit_time_date":{"type":"boolean"}}}},"components/schemas/timezone_settings":{"id":"components/schemas/timezone_settings","kind":"json-schema","title":"timezone_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"timezone":{"type":"string"}}}},"components/schemas/language_settings":{"id":"components/schemas/language_settings","kind":"json-schema","title":"language_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"device_locale":{"type":"string"}}}},"components/schemas/strict_wifi_synchronization_settings":{"id":"components/schemas/strict_wifi_synchronization_settings","kind":"json-schema","title":"strict_wifi_synchronization_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_strict_wifi_synchronization":{"type":"boolean"}}}},"components/schemas/strict_app_synchronization_settings":{"id":"components/schemas/strict_app_synchronization_settings","kind":"json-schema","title":"strict_app_synchronization_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_strict_app_synchronization":{"type":"boolean"}}}},"components/schemas/app":{"id":"components/schemas/app","kind":"json-schema","title":"app","data":{"type":"object","properties":{"app_id":{"type":"string"},"app_version_id":{"type":"string"},"package_name":{"type":"string"},"installation_rule":{"type":"string","enum":["POST PROVISIONING","DURING PROVISIONING"]},"state":{"type":"string","enum":["SHOW","HIDE","DISABLE","LAUNCHABLE_BUT_HIDDEN"]},"managed_config":{"type":"object"},"type":{"type":"string","enum":["PRELOADED","ENTERPRISE","PLAYSTORE"]},"auto_update_mode":{"type":"string","enum":["autoUpdateDefault","autoUpdateHighPriority","autoUpdatePostponed"]}},"required":["app_id","app_version_id","package_name","installation_rule","state","type","auto_update_mode"]}},"components/schemas/apps":{"id":"components/schemas/apps","kind":"json-schema","title":"apps","data":{"type":"array","items":{"$ref":"#/components/schemas/app"}}},"components/schemas/file":{"id":"components/schemas/file","kind":"json-schema","title":"file","data":{"type":"object","properties":{"file_id":{"type":"string"},"destination_path":{"type":"string"}},"required":["file_id","destination_path","tags"]}},"components/schemas/files":{"id":"components/schemas/files","kind":"json-schema","title":"files","data":{"type":"array","items":{"$ref":"#/components/schemas/file"}}},"components/schemas/wifi_network":{"id":"components/schemas/wifi_network","kind":"json-schema","title":"wifi_network","data":{"type":"object","properties":{"wifi_network_id":{"type":"string"},"certificate_file_path":{"type":"string","example":"/storage/emulated/0/Documents"},"certificate_file_password":{"type":"string","example":"abc"}},"required":["wifi_network_id"]}},"components/schemas/wifi_networks":{"id":"components/schemas/wifi_networks","kind":"json-schema","title":"wifi_networks","data":{"type":"array","items":{"$ref":"#/components/schemas/wifi_network"}}},"components/schemas/saved_ap_settings":{"id":"components/schemas/saved_ap_settings","kind":"json-schema","title":"saved_ap_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"use_only_saved_ap":{"type":"boolean"}},"required":["apply_policy","use_only_saved_ap"]}},"components/schemas/mac_address_randomization_settings":{"id":"components/schemas/mac_address_randomization_settings","kind":"json-schema","title":"mac_address_randomization_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_mac_address_randomization":{"type":"boolean"}}}},"components/schemas/esper_edgebox_settings":{"id":"components/schemas/esper_edgebox_settings","kind":"json-schema","title":"esper_edgebox_settings","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_esper_edgebox":{"type":"boolean"}}}},"components/schemas/app_layout_setting":{"id":"components/schemas/app_layout_setting","kind":"json-schema","title":"app_layout_setting","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"brand_logo_position":{"type":"string","enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"]},"device_name_position":{"type":"string","enum":["BOTTOM_LEFT","BOTTOM_RIGHT","TOP_LEFT","TOP_RIGHT"]},"app_icon_size":{"type":"string","enum":["SMALL_ICON","MEDIUM_ICON","LARGE_ICON","DEFAULT_ICON","CUSTOM_ICON"]},"app_name_size":{"type":"string","enum":["SMALL_TEXT","MEDIUM_TEXT","LARGE_TEXT","DEFAULT_TEXT","CUSTOM_TEXT"]},"device_name_and_id_display_policy":{"type":"string","enum":["NONE","DEFAULT","DEVICE_ID_ONLY","ALIAS_NAME_ONLY","DEVICE_ID_AND_ALIAS_NAME"]},"device_name_size":{"type":"string","enum":["SMALL_TEXT","MEDIUM_TEXT","LARGE_TEXT","DEFAULT_TEXT","CUSTOM_TEXT"]},"device_alias_size":{"type":"string","enum":["SMALL_TEXT","MEDIUM_TEXT","LARGE_TEXT","DEFAULT_TEXT","CUSTOM_TEXT"]},"custom_app_icon_size":{"type":"integer","minimum":20,"maximum":100},"custom_device_name_size":{"type":"integer","minimum":20,"maximum":100},"custom_device_alias_size":{"type":"integer","minimum":20,"maximum":100},"custom_app_name_size":{"type":"integer","minimum":20,"maximum":100}}}},"components/schemas/app_icon":{"id":"components/schemas/app_icon","kind":"json-schema","title":"app_icon","data":{"type":"object","properties":{"type":{"type":"string","enum":["SINGLE_APP"]},"name":{"type":"string"}}}},"components/schemas/app_order_setting":{"id":"components/schemas/app_order_setting","kind":"json-schema","title":"app_order_setting","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"app_order_list":{"type":"array","items":{"$ref":"#/components/schemas/app_icon"}}}}},"components/schemas/settings":{"id":"components/schemas/settings","kind":"json-schema","title":"settings","data":{"type":"object","properties":{"device_mode_settings":{"$ref":"#/components/schemas/device_mode_settings"},"launcher_settings":{"$ref":"#/components/schemas/launcher_settings"},"local_app_install_settings":{"$ref":"#/components/schemas/local_app_install_settings"},"app_uninstall_settings":{"$ref":"#/components/schemas/app_uninstall_settings"},"app_permission_policy_settings":{"$ref":"#/components/schemas/app_permission_policy_settings"},"wifi_settings":{"$ref":"#/components/schemas/wifi_settings"},"bluetooth_settings":{"$ref":"#/components/schemas/bluetooth_settings"},"sms_settings":{"$ref":"#/components/schemas/sms_settings"},"nfc_settings":{"$ref":"#/components/schemas/nfc_settings"},"incoming_numbers_settings":{"$ref":"#/components/schemas/incoming_numbers_settings"},"outgoing_numbers_settings":{"$ref":"#/components/schemas/outgoing_numbers_settings"},"ethernet_settings":{"$ref":"#/components/schemas/ethernet_settings"},"adb_settings":{"$ref":"#/components/schemas/adb_settings"},"safe_boot_settings":{"$ref":"#/components/schemas/safe_boot_settings"},"factory_reset_settings":{"$ref":"#/components/schemas/factory_reset_settings"},"screen_timeout_settings":{"$ref":"#/components/schemas/screen_timeout_settings"},"lock_screen_settings":{"$ref":"#/components/schemas/lock_screen_settings"},"brightness_settings":{"$ref":"#/components/schemas/brightness_settings"},"screen_orientation_settings":{"$ref":"#/components/schemas/screen_orientation_settings"},"screenshot_settings":{"$ref":"#/components/schemas/screenshot_settings"},"notification_bar_settings":{"$ref":"#/components/schemas/notification_bar_settings"},"wallpaper_settings":{"$ref":"#/components/schemas/wallpaper_settings"},"esper_settings_apps_settings":{"$ref":"#/components/schemas/esper_settings_apps_settings"},"android_settings_app_settings":{"$ref":"#/components/schemas/android_settings_app_settings"},"customized_device_level_json_settings":{"$ref":"#/components/schemas/customized_device_level_json_settings"},"google_services_settings":{"$ref":"#/components/schemas/google_services_settings"},"external_device_settings":{"$ref":"#/components/schemas/external_device_settings"},"usb_tethering_settings":{"$ref":"#/components/schemas/usb_tethering_settings"},"file_transfer_settings":{"$ref":"#/components/schemas/file_transfer_settings"},"camera_settings":{"$ref":"#/components/schemas/camera_settings"},"location_settings":{"$ref":"#/components/schemas/location_settings"},"sound_settings":{"$ref":"#/components/schemas/sound_settings"},"system_updates_settings":{"$ref":"#/components/schemas/system_updates_settings"},"time_date_settings":{"$ref":"#/components/schemas/time_date_settings"},"timezone_settings":{"$ref":"#/components/schemas/timezone_settings"},"language_settings":{"$ref":"#/components/schemas/language_settings"},"strict_wifi_synchronization_settings":{"$ref":"#/components/schemas/strict_wifi_synchronization_settings"},"strict_app_synchronization_settings":{"$ref":"#/components/schemas/strict_app_synchronization_settings"},"apps":{"$ref":"#/components/schemas/apps"},"files":{"$ref":"#/components/schemas/files"},"wifi_networks":{"$ref":"#/components/schemas/wifi_networks"},"saved_ap_settings":{"$ref":"#/components/schemas/saved_ap_settings"},"mac_address_randomization_settings":{"$ref":"#/components/schemas/mac_address_randomization_settings"},"esper_edgebox_settings":{"$ref":"#/components/schemas/esper_edgebox_settings"},"app_layout_setting":{"$ref":"#/components/schemas/app_layout_setting"},"app_order_setting":{"$ref":"#/components/schemas/app_order_setting"}}}},"components/schemas/kiosk_mode_settings":{"id":"components/schemas/kiosk_mode_settings","kind":"json-schema","title":"kiosk_mode_settings","data":{"type":"object","properties":{"app_id":{"type":"string"},"app_type":{"type":"string","enum":["VPP","TENANT_IOS","ESPER_IOS","WEBCLIP","PRELOADED"]}}}},"components/schemas/local_app_install_settings_ios":{"id":"components/schemas/local_app_install_settings_ios","kind":"json-schema","title":"local_app_install_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_local_app_install":{"type":"boolean","default":true}},"required":["apply_policy","allow_local_app_install"]}},"components/schemas/app_uninstall_settings_ios":{"id":"components/schemas/app_uninstall_settings_ios","kind":"json-schema","title":"app_uninstall_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_app_uninstallation":{"type":"boolean","default":true}},"required":["apply_policy","allow_app_uninstallation"]}},"components/schemas/bluetooth_settings_ios":{"id":"components/schemas/bluetooth_settings_ios","kind":"json-schema","title":"bluetooth_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"edit_bluetooth":{"type":"boolean","default":true}},"required":["apply_policy","edit_bluetooth"]}},"components/schemas/nfc_settings_ios":{"id":"components/schemas/nfc_settings_ios","kind":"json-schema","title":"nfc_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_nfc":{"type":"boolean","default":true}},"required":["apply_policy","allow_nfc"]}},"components/schemas/factory_reset_settings_ios":{"id":"components/schemas/factory_reset_settings_ios","kind":"json-schema","title":"factory_reset_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_factory_reset":{"type":"boolean","default":true}},"required":["apply_policy","allow_factory_reset"]}},"components/schemas/screenshot_settings_ios":{"id":"components/schemas/screenshot_settings_ios","kind":"json-schema","title":"screenshot_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_screenshot":{"type":"boolean","default":true}}}},"components/schemas/custom_device_level_profile_settings_ios":{"id":"components/schemas/custom_device_level_profile_settings_ios","kind":"json-schema","title":"custom_device_level_profile_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"custom_profile":{"type":"string","nullable":true}},"required":["customized_profile"]}},"components/schemas/siri_settings_ios":{"id":"components/schemas/siri_settings_ios","kind":"json-schema","title":"siri_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_siri":{"type":"boolean","default":true}},"required":["apply_policy","allow_siri"]}},"components/schemas/tethering_settings_ios":{"id":"components/schemas/tethering_settings_ios","kind":"json-schema","title":"tethering_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"edit_hotspot":{"type":"boolean","default":true}}}},"components/schemas/camera_settings_ios":{"id":"components/schemas/camera_settings_ios","kind":"json-schema","title":"camera_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_camera_access":{"type":"boolean","default":true}}}},"components/schemas/hide_preloaded_apps_settings_ios":{"id":"components/schemas/hide_preloaded_apps_settings_ios","kind":"json-schema","title":"hide_preloaded_apps_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"hide_preloaded_apps":{"type":"boolean","default":true}}}},"components/schemas/time_date_settings_ios":{"id":"components/schemas/time_date_settings_ios","kind":"json-schema","title":"time_date_settings_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"force_automatic_time_date":{"type":"boolean","default":false}}}},"components/schemas/wifi_network_ios":{"id":"components/schemas/wifi_network_ios","kind":"json-schema","title":"wifi_network_ios","data":{"type":"object","properties":{"wifi_network_id":{"type":"string"}},"required":["wifi_network_id"]}},"components/schemas/wifi_networks_ios":{"id":"components/schemas/wifi_networks_ios","kind":"json-schema","title":"wifi_networks_ios","data":{"type":"array","items":{"$ref":"#/components/schemas/wifi_network_ios"}}},"components/schemas/ios_app":{"id":"components/schemas/ios_app","kind":"json-schema","title":"ios_app","data":{"type":"object","properties":{"app_id":{"type":"string"},"app_version_id":{"type":"string"},"state":{"type":"string","enum":["SHOW"]},"app_type":{"type":"string","enum":["VPP","TENANT_IOS","ESPER_IOS","WEBCLIP","PRELOADED"]},"base64_app_config":{"type":"string"}},"required":["app_id","app_version_id","state","app_type"]}},"components/schemas/ios_apps":{"id":"components/schemas/ios_apps","kind":"json-schema","title":"ios_apps","data":{"type":"array","items":{"$ref":"#/components/schemas/ios_app"}}},"components/schemas/provisioning_profile_ios":{"id":"components/schemas/provisioning_profile_ios","kind":"json-schema","title":"provisioning_profile_ios","data":{"type":"object","properties":{"profile_id":{"type":"string","format":"uuid"},"profile_version_id":{"type":"string","format":"uuid"}},"required":["profile_id","profile_version_id"]}},"components/schemas/provisioning_profiles_ios":{"id":"components/schemas/provisioning_profiles_ios","kind":"json-schema","title":"provisioning_profiles_ios","data":{"type":"array","items":{"$ref":"#/components/schemas/provisioning_profile_ios"}}},"components/schemas/ios_wallpaper_settings":{"id":"components/schemas/ios_wallpaper_settings","kind":"json-schema","title":"ios_wallpaper_settings","data":{"type":"object","properties":{"homescreen":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"portrait":{"type":"object","properties":{"wallpaper_id":{"type":"string"}}}}},"lockscreen":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"portrait":{"type":"object","properties":{"wallpaper_id":{"type":"string"}}}}}}}},"components/schemas/web_content_setting_ios":{"id":"components/schemas/web_content_setting_ios","kind":"json-schema","title":"web_content_setting_ios","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"url_blocklist":{"type":"array","items":{"type":"string"}},"url_allowlist":{"type":"array","items":{"type":"string"}}}}},"components/schemas/defer_os_updates":{"id":"components/schemas/defer_os_updates","kind":"json-schema","title":"defer_os_updates","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"defer_os_updates_delay":{"type":"integer","minimum":0,"maximum":90}}}},"components/schemas/iosSettings":{"id":"components/schemas/iosSettings","kind":"json-schema","title":"iosSettings","data":{"type":"object","properties":{"kiosk_app":{"$ref":"#/components/schemas/kiosk_mode_settings"},"device_mode_settings":{"$ref":"#/components/schemas/device_mode_settings"},"local_app_install_settings":{"$ref":"#/components/schemas/local_app_install_settings_ios"},"app_uninstall_settings":{"$ref":"#/components/schemas/app_uninstall_settings_ios"},"bluetooth_settings":{"$ref":"#/components/schemas/bluetooth_settings_ios"},"nfc_settings":{"$ref":"#/components/schemas/nfc_settings_ios"},"factory_reset_settings":{"$ref":"#/components/schemas/factory_reset_settings_ios"},"screenshot_settings":{"$ref":"#/components/schemas/screenshot_settings_ios"},"custom_device_level_profile_settings":{"$ref":"#/components/schemas/custom_device_level_profile_settings_ios"},"siri_settings":{"$ref":"#/components/schemas/siri_settings_ios"},"tethering_settings":{"$ref":"#/components/schemas/tethering_settings_ios"},"camera_settings":{"$ref":"#/components/schemas/camera_settings_ios"},"hide_preloaded_apps_settings":{"$ref":"#/components/schemas/hide_preloaded_apps_settings_ios"},"time_date_settings":{"$ref":"#/components/schemas/time_date_settings_ios"},"wifi_networks":{"$ref":"#/components/schemas/wifi_networks_ios"},"apps":{"$ref":"#/components/schemas/ios_apps"},"provisioning_profiles":{"$ref":"#/components/schemas/provisioning_profiles_ios"},"wallpaper_settings":{"$ref":"#/components/schemas/ios_wallpaper_settings"},"web_content_settings":{"$ref":"#/components/schemas/web_content_setting_ios"},"defer_os_updates":{"$ref":"#/components/schemas/defer_os_updates"}}}},"components/schemas/shellScriptLinux":{"id":"components/schemas/shellScriptLinux","kind":"json-schema","title":"shellScriptLinux","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"script":{"type":"string","description":"The shell script to be executed."},"interpreter":{"type":"string","description":"The interpreter to use for the script (e.g., bash)."},"alias":{"type":"string","description":"A user-friendly name or alias for the script."},"description":{"type":"string","description":"A description of what the script does."}},"required":["apply_policy","script","interpreter","alias"]}},"components/schemas/customShellScriptsMultiple":{"id":"components/schemas/customShellScriptsMultiple","kind":"json-schema","title":"customShellScriptsMultiple","data":{"type":"object","properties":{"shell_scripts":{"type":"array","items":{"$ref":"#/components/schemas/shellScriptLinux"}}}}},"components/schemas/customActionLinux":{"id":"components/schemas/customActionLinux","kind":"json-schema","title":"customActionLinux","data":{"type":"object","description":"Reference to a custom action to be applied on Linux devices within a blueprint.","properties":{"id":{"type":"string","format":"uuid","description":"The UUID of the custom action to apply."},"options_key":{"type":"string","format":"uuid","description":"The UUID of the specific option key within the Custom Action to use."},"apply_policy":{"$ref":"#/components/schemas/apply_policy"}},"required":["id","options_key","apply_policy"]}},"components/schemas/customActionsMultipleLinux":{"id":"components/schemas/customActionsMultipleLinux","kind":"json-schema","title":"customActionsMultipleLinux","data":{"type":"object","description":"Collection of custom actions to be applied on Linux devices.","properties":{"custom_actions":{"type":"array","description":"List of custom actions to apply to Linux devices.","items":{"$ref":"#/components/schemas/customActionLinux"}}}}},"components/schemas/linuxFile":{"id":"components/schemas/linuxFile","kind":"json-schema","title":"linuxFile","data":{"type":"object","properties":{"file_id":{"type":"integer"},"destination_path":{"type":"string","example":"/tmp"}},"required":["file_id","destination_path"]}},"components/schemas/linuxFiles":{"id":"components/schemas/linuxFiles","kind":"json-schema","title":"linuxFiles","data":{"type":"array","items":{"$ref":"#/components/schemas/linuxFile"}}},"components/schemas/linuxSettings":{"id":"components/schemas/linuxSettings","kind":"json-schema","title":"linuxSettings","data":{"type":"object","description":"Configuration settings specific to Linux devices in a blueprint","properties":{"custom_shell_scripts_multiple":{"$ref":"#/components/schemas/customShellScriptsMultiple"},"custom_actions_multiple":{"$ref":"#/components/schemas/customActionsMultipleLinux"},"files":{"$ref":"#/components/schemas/linuxFiles"}}}},"components/schemas/active_hours_settings_windows":{"id":"components/schemas/active_hours_settings_windows","kind":"json-schema","title":"active_hours_settings_windows","data":{"type":"object","description":"Windows active hours configuration for controlling update installation timing","properties":{"active_hours_start":{"type":"object","description":"Start time for active hours","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"time":{"type":"integer","minimum":0,"maximum":23,"default":8,"description":"Start hour in 24-hour format (0-23)"}},"required":["apply_policy","time"]},"active_hours_end":{"type":"object","description":"End time for active hours","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"time":{"type":"integer","minimum":0,"maximum":23,"default":17,"description":"End hour in 24-hour format (0-23)"}},"required":["apply_policy","time"]}},"required":["active_hours_start","active_hours_end"]}},"components/schemas/windows_app":{"id":"components/schemas/windows_app","kind":"json-schema","title":"windows_app","data":{"type":"object","properties":{"app_id":{"type":"string"},"app_version_id":{"type":"string"},"state":{"type":"string","enum":["SHOW"]},"app_type":{"type":"string","enum":["TENANT_WINDOWS","ESPER_WINDOWS"]},"base64_app_config":{"type":"string"}},"required":["app_id","app_version_id","state","app_type"]}},"components/schemas/windows_apps":{"id":"components/schemas/windows_apps","kind":"json-schema","title":"windows_apps","data":{"type":"array","items":{"$ref":"#/components/schemas/windows_app"}}},"components/schemas/auto_update_settings_windows":{"id":"components/schemas/auto_update_settings_windows","kind":"json-schema","title":"auto_update_settings_windows","data":{"type":"object","description":"Windows automatic updates configuration","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"auto_update_type":{"type":"string","enum":["DEFAULT","OFF"],"default":"DEFAULT","description":"Type of automatic update behavior - DEFAULT allows system default behavior, OFF disables automatic updates"}},"required":["apply_policy","auto_update_type"]}},"components/schemas/powerShellScriptWindows":{"id":"components/schemas/powerShellScriptWindows","kind":"json-schema","title":"powerShellScriptWindows","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"script":{"type":"string","description":"The PowerShell script to be executed."},"interpreter":{"type":"string","maxLength":255,"description":"The interpreter to use for the script (e.g., powershell)."},"alias":{"type":"string","maxLength":100,"description":"A user-friendly name or alias for the script."},"description":{"type":"string","maxLength":300,"description":"A description of what the script does."}},"required":["apply_policy","script","interpreter","alias"]}},"components/schemas/customShellScriptsMultipleWindows":{"id":"components/schemas/customShellScriptsMultipleWindows","kind":"json-schema","title":"customShellScriptsMultipleWindows","data":{"type":"object","properties":{"shell_scripts":{"type":"array","maxItems":10,"items":{"$ref":"#/components/schemas/powerShellScriptWindows"}}}}},"components/schemas/defer_os_updates_windows":{"id":"components/schemas/defer_os_updates_windows","kind":"json-schema","title":"defer_os_updates_windows","data":{"type":"object","description":"Windows OS updates deferral configuration with separate quality and feature update controls","properties":{"quality_updates":{"type":"object","description":"Quality updates deferral settings","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"defer_days":{"type":"integer","minimum":0,"maximum":30,"default":0,"description":"Number of days to defer quality updates"}},"required":["apply_policy","defer_days"]},"feature_updates":{"type":"object","description":"Feature updates deferral settings","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"defer_days":{"type":"integer","minimum":0,"maximum":365,"default":0,"description":"Number of days to defer feature updates"}},"required":["apply_policy","defer_days"]}},"required":["quality_updates","feature_updates"]}},"components/schemas/windows_kiosk_win32_single_app_config":{"id":"components/schemas/windows_kiosk_win32_single_app_config","kind":"json-schema","title":"windows_kiosk_win32_single_app_config","data":{"type":"object","description":"Win32 single-app kiosk configuration. Defaults applied if not provided.","properties":{"name":{"type":"string","description":"Name of the kiosk profile"},"desktop_app_path":{"type":"string","description":"Absolute path to the kiosk desktop app executable (required)"},"auto_launch":{"type":"boolean","default":true,"description":"Automatically launch the app"},"auto_launch_arguments":{"type":"string","default":"","description":"Arguments passed to the app on launch"},"hide_taskbar":{"type":"boolean","default":true,"description":"Hide Windows taskbar"},"hide_start_recommended_section":{"type":"boolean","default":true,"description":"Hide Recommended section from Start menu"},"hide_power_button":{"type":"boolean","default":false,"description":"Hide power button in Start menu"}}}},"components/schemas/windows_kiosk_settings":{"id":"components/schemas/windows_kiosk_settings","kind":"json-schema","title":"windows_kiosk_settings","data":{"type":"object","description":"Windows kiosk configuration settings for single-app Win32 assigned access.","properties":{"win32_single_app_config":{"$ref":"#/components/schemas/windows_kiosk_win32_single_app_config"}}}},"components/schemas/pause_os_updates_windows":{"id":"components/schemas/pause_os_updates_windows","kind":"json-schema","title":"pause_os_updates_windows","data":{"type":"object","description":"Windows pause OS updates configuration","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"pause_os_updates":{"type":"boolean","default":false,"description":"Whether to pause OS updates"}},"required":["apply_policy","pause_os_updates"]}},"components/schemas/unenrollment_settings_windows":{"id":"components/schemas/unenrollment_settings_windows","kind":"json-schema","title":"unenrollment_settings_windows","data":{"type":"object","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"allow_unenrollment_from_device":{"type":"boolean"}},"required":["apply_policy","allow_unenrollment_from_device"]}},"components/schemas/windows_wallpaper_settings":{"id":"components/schemas/windows_wallpaper_settings","kind":"json-schema","title":"windows_wallpaper_settings","data":{"type":"object","description":"Configuration for Windows desktop wallpaper settings including homescreen and lockscreen backgrounds. Uses landscape orientation only.","properties":{"homescreen":{"type":"object","description":"Wallpaper settings for the Windows desktop homescreen","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"landscape":{"type":"object","description":"Landscape wallpaper configuration","properties":{"wallpaper_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier for the wallpaper resource"}}}}},"lockscreen":{"type":"object","description":"Wallpaper settings for the Windows lock screen","properties":{"apply_policy":{"$ref":"#/components/schemas/apply_policy"},"landscape":{"type":"object","description":"Landscape wallpaper configuration","properties":{"wallpaper_id":{"type":"string","format":"uuid","nullable":true,"description":"Unique identifier for the wallpaper resource"}}}}}}}},"components/schemas/wifi_network_windows":{"id":"components/schemas/wifi_network_windows","kind":"json-schema","title":"wifi_network_windows","data":{"type":"object","properties":{"wifi_network_id":{"type":"string"}},"required":["wifi_network_id"]}},"components/schemas/wifi_networks_windows":{"id":"components/schemas/wifi_networks_windows","kind":"json-schema","title":"wifi_networks_windows","data":{"type":"array","items":{"$ref":"#/components/schemas/wifi_network_windows"}}},"components/schemas/windowsSettings":{"id":"components/schemas/windowsSettings","kind":"json-schema","title":"windowsSettings","data":{"type":"object","properties":{"active_hours_settings":{"$ref":"#/components/schemas/active_hours_settings_windows"},"apps":{"$ref":"#/components/schemas/windows_apps"},"auto_update_settings":{"$ref":"#/components/schemas/auto_update_settings_windows"},"bluetooth_settings":{"$ref":"#/components/schemas/bluetooth_settings"},"camera_settings":{"$ref":"#/components/schemas/camera_settings"},"custom_shell_scripts_multiple":{"$ref":"#/components/schemas/customShellScriptsMultipleWindows"},"device_mode_settings":{"$ref":"#/components/schemas/device_mode_settings"},"defer_os_updates":{"$ref":"#/components/schemas/defer_os_updates_windows"},"factory_reset_settings":{"$ref":"#/components/schemas/factory_reset_settings"},"kiosk_settings":{"$ref":"#/components/schemas/windows_kiosk_settings"},"pause_os_updates":{"$ref":"#/components/schemas/pause_os_updates_windows"},"timezone_settings":{"$ref":"#/components/schemas/timezone_settings"},"unenrollment_settings":{"$ref":"#/components/schemas/unenrollment_settings_windows"},"wallpaper_settings":{"$ref":"#/components/schemas/windows_wallpaper_settings"},"wifi_networks":{"$ref":"#/components/schemas/wifi_networks_windows"}}}},"components/schemas/settingsV2":{"id":"components/schemas/settingsV2","kind":"json-schema","title":"settingsV2","data":{"type":"object","properties":{"android":{"$ref":"#/components/schemas/settings"},"ios":{"$ref":"#/components/schemas/iosSettings"},"linux":{"$ref":"#/components/schemas/linuxSettings"},"windows":{"$ref":"#/components/schemas/windowsSettings"}}}},"components/schemas/BlueprintV2":{"id":"components/schemas/BlueprintV2","kind":"json-schema","title":"BlueprintV2","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Name of the blueprint"},"description":{"type":"string","description":"Description of the blueprint"},"comments":{"type":"string","description":"Comments on the blueprint"},"version_number":{"type":"integer","readOnly":true},"version_id":{"type":"string","format":"uuid","readOnly":true},"minor_version_number":{"type":"integer","readOnly":true},"publish":{"type":"boolean","readOnly":true},"settings":{"$ref":"#/components/schemas/settingsV2"},"created_by":{"type":"string","description":"ID of the user who created the blueprint","readOnly":true},"updated_by":{"type":"string","description":"ID of the user who updated the blueprint","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}}},"components/schemas/BlueprintV2Put":{"id":"components/schemas/BlueprintV2Put","kind":"json-schema","title":"BlueprintV2Put","data":{"allOf":[{"$ref":"#/components/schemas/BlueprintV2"},{"type":"object","properties":{"publish":{"type":"boolean","description":"Field to indicate whether to publish the blueprint\n","readOnly":false}}}]}},"components/schemas/customActionBase":{"id":"components/schemas/customActionBase","kind":"json-schema","title":"customActionBase","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50,"description":"Custom Action name"},"type":{"type":"string","enum":["button","toggle","radio","dropdown"],"description":"The UI component type for this custom action"},"state":{"type":"string","enum":["draft","active","inactive"],"description":"The current operational state of the custom action. Only active custom actions can be deployed to Linux devices."},"position_in_blueprints":{"type":"string","enum":["none","blueprints_apps_and_configuration","blueprints_connectivity","blueprints_device_security","blueprints_display_and_branding","blueprints_esper_settings","blueprints_scripts","blueprints_files","blueprints_platform_services","blueprints_hardware_settings","blueprints_sound","blueprints_system_updates","blueprints_time_and_date"],"description":"The location in the blueprint where the custom action will be added"},"position_in_device_settings":{"type":"string","enum":["none","device_quick_settings"],"description":"The location in the device's Quick Actions where the custom action will be added"},"properties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object for the description, info_message, and tooltip_message."},"children":[]}]}]}]}},"required":["name","type","state","position_in_blueprints","position_in_device_settings","properties"]}},"components/schemas/platformScriptResponse":{"id":"components/schemas/platformScriptResponse","kind":"json-schema","title":"platformScriptResponse","data":{"type":"object","properties":{"script_id":{"type":"string","format":"uuid","description":"Script identifier stored in external storage"}},"required":["script_id"]}},"components/schemas/options_response":{"id":"components/schemas/options_response","kind":"json-schema","title":"options_response","data":{"type":"object","properties":{"label":{"type":"string","description":"Label shown on the UI"},"key":{"type":"string","format":"uuid","description":"Unique key identifier for the option"},"scripts":{"type":"object","description":"Platform-specific script references. Currently only Linux platform is supported. Platform key must be lowercase \"linux\".","properties":{"linux":{"$ref":"#/components/schemas/platformScriptResponse"}},"required":["linux"],"additionalProperties":false}},"required":["label","key","scripts"]}},"components/schemas/CustomActionRead":{"id":"components/schemas/CustomActionRead","kind":"json-schema","title":"CustomActionRead","data":{"allOf":[{"$ref":"#/components/schemas/customActionBase"},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom action"},"options":{"type":"array","items":{"$ref":"#/components/schemas/options_response"},"description":"List of options for the custom action"},"created_at":{"type":"string","format":"date-time","description":"When the custom action was created"},"updated_at":{"type":"string","format":"date-time","description":"When the custom action was last updated"},"created_by":{"type":"integer","description":"User ID who created the custom action"},"updated_by":{"type":"integer","description":"User ID who last updated the custom action"}},"required":["id","options","created_at","updated_at","created_by","updated_by"]}]}},"components/schemas/platformScriptRequest":{"id":"components/schemas/platformScriptRequest","kind":"json-schema","title":"platformScriptRequest","data":{"type":"object","properties":{"script":{"type":"string","description":"The script content to be executed on Linux devices"},"interpreter":{"type":"string","maxLength":255,"description":"Interpreter used to run the script. Default is \"bash\" if not specified. Common values include \"bash\", \"sh\", \"python\", \"python3\"","default":"bash"}},"required":["script","interpreter"]}},"components/schemas/optionsRequest":{"id":"components/schemas/optionsRequest","kind":"json-schema","title":"optionsRequest","data":{"type":"object","properties":{"label":{"type":"string","description":"Label shown on the UI"},"key":{"type":"string","format":"uuid","description":"Unique key identifier for the option"},"scripts":{"type":"object","description":"Platform-specific scripts. Currently only Linux platform is supported. Platform key must be lowercase \"linux\".","properties":{"linux":{"$ref":"#/components/schemas/platformScriptRequest"}},"required":["linux"],"additionalProperties":false}},"required":["label","key","scripts"]}},"components/schemas/CustomActionCreate":{"id":"components/schemas/CustomActionCreate","kind":"json-schema","title":"CustomActionCreate","data":{"allOf":[{"$ref":"#/components/schemas/customActionBase"},{"type":"object","properties":{"options":{"type":"array","items":{"$ref":"#/components/schemas/optionsRequest"},"description":"List of options for the custom action"}},"required":["options"]}]}},"components/schemas/CustomActionUpdate":{"id":"components/schemas/CustomActionUpdate","kind":"json-schema","title":"CustomActionUpdate","data":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50,"description":"Custom action name"},"type":{"type":"string","enum":["button","toggle","radio","dropdown"],"description":"The UI component type for this custom action"},"state":{"type":"string","enum":["draft","active","inactive"],"description":"The current operational state of the custom action"},"position_in_blueprints":{"type":"string","enum":["none","blueprints_apps_and_configuration","blueprints_connectivity","blueprints_device_security","blueprints_display_and_branding","blueprints_esper_settings","blueprints_scripts","blueprints_files","blueprints_platform_services","blueprints_hardware_settings","blueprints_sound","blueprints_system_updates","blueprints_time_and_date"],"description":"The location in the blueprint where the custom action will be added"},"position_in_device_settings":{"type":"string","enum":["none","device_quick_settings"],"description":"The location in the device's Quick Actions where the custom action will be added"},"properties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object for the description, info_message, and tooltip_message. Replaces the existing properties."},"children":[]}]}]}]},"options":{"type":"array","items":{"$ref":"#/components/schemas/optionsRequest"},"description":"A new list of options to replace the existing ones"}},"description":"Update a custom action. All fields are optional."}},"components/schemas/platformScript":{"id":"components/schemas/platformScript","kind":"json-schema","title":"platformScript","data":{"type":"object","properties":{"script":{"type":"string","description":"The script content"},"interpreter":{"type":"string","description":"Interpreter used to run the script"}},"required":["script","interpreter"]}},"components/schemas/Pipeline":{"id":"components/schemas/Pipeline","kind":"json-schema","title":"Pipeline","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"enterprise_id":{"type":"string","readOnly":true},"name":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"is_valid":{"type":"boolean"},"is_visible":{"type":"boolean"},"is_archived":{"type":"boolean"},"is_default":{"type":"boolean"},"timeout_seconds":{"type":"number","format":"int32"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["name","created_by","updated_by"]}},"components/schemas/Pipeline_POST":{"id":"components/schemas/Pipeline_POST","kind":"json-schema","title":"Pipeline_POST","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"is_default":{"type":"boolean","default":false},"is_active":{"type":"boolean","default":true},"timeout_seconds":{"type":"number","format":"int32","default":86400}},"required":["name"]}},"components/schemas/Error_400_Bad_Data":{"id":"components/schemas/Error_400_Bad_Data","kind":"json-schema","title":"Error_400_Bad_Data","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","default":400},"message":{"type":"string"},"content":{"type":"object"}},"required":["code","message"]}},"components/schemas/Error_401_Unauthorized":{"id":"components/schemas/Error_401_Unauthorized","kind":"json-schema","title":"Error_401_Unauthorized","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","default":401},"message":{"type":"string"},"content":{"type":"object"}},"required":["code","message"]}},"components/schemas/Pipeline_PUT":{"id":"components/schemas/Pipeline_PUT","kind":"json-schema","title":"Pipeline_PUT","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"is_active":{"type":"boolean"},"is_default":{"type":"boolean"},"timeout_seconds":{"type":"number","format":"int32"}}}},"components/schemas/Stage":{"id":"components/schemas/Stage","kind":"json-schema","title":"Stage","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"enterprise_id":{"type":"string","readOnly":true},"pipeline_id":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"timeout_seconds":{"type":"number","format":"int32"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Stage_POST":{"id":"components/schemas/Stage_POST","kind":"json-schema","title":"Stage_POST","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout_seconds":{"type":"number","format":"int32"}},"required":["name"]}},"components/schemas/Stage_PUT":{"id":"components/schemas/Stage_PUT","kind":"json-schema","title":"Stage_PUT","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"timeout_seconds":{"type":"number","format":"int32"}}}},"components/schemas/TargetList":{"id":"components/schemas/TargetList","kind":"json-schema","title":"TargetList","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"pipeline_id":{"type":"string"},"name":{"type":"string"},"target_list_type":{"type":"string"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/StageTargetList_POST":{"id":"components/schemas/StageTargetList_POST","kind":"json-schema","title":"StageTargetList_POST","data":{"type":"object","properties":{"target_list_id":{"type":"string","format":"uuid"}},"required":["target_list_id"]}},"components/schemas/OperationList":{"id":"components/schemas/OperationList","kind":"json-schema","title":"OperationList","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"pipeline_id":{"type":"string"},"stage_id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/OperationList_POST":{"id":"components/schemas/OperationList_POST","kind":"json-schema","title":"OperationList_POST","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"pipeline_id":{"type":"string","format":"uuid"}},"required":["name"]}},"components/schemas/TargetList_POST":{"id":"components/schemas/TargetList_POST","kind":"json-schema","title":"TargetList_POST","data":{"type":"object","properties":{"name":{"type":"string"},"target_list_type":{"type":"string","enum":["DEVICES","GROUPS","COLLECTIONS"]}},"required":["name","target_list_type"]}},"components/schemas/Target":{"id":"components/schemas/Target","kind":"json-schema","title":"Target","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"pipeline_id":{"type":"string","format":"uuid"},"device_id":{"type":"string","format":"uuid"},"device_name":{"type":"string"},"device_alias":{"type":"string"},"is_active":{"type":"boolean"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Target_POST":{"id":"components/schemas/Target_POST","kind":"json-schema","title":"Target_POST","data":{"type":"object","properties":{"device_id":{"type":"string","format":"uuid"},"device_alias":{"type":"string"},"device_name":{"type":"string"},"is_active":{"type":"boolean"}},"required":["device_id","device_name"]}},"components/schemas/Target_PUT":{"id":"components/schemas/Target_PUT","kind":"json-schema","title":"Target_PUT","data":{"type":"object","properties":{"device_name":{"type":"string"},"is_active":{"type":"boolean"}}}},"components/schemas/Error_500_Internal_Server_Error":{"id":"components/schemas/Error_500_Internal_Server_Error","kind":"json-schema","title":"Error_500_Internal_Server_Error","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","default":500},"message":{"type":"string"},"content":{"type":"object"}},"required":["code","message"]}},"components/schemas/TargetListDeviceGroup":{"id":"components/schemas/TargetListDeviceGroup","kind":"json-schema","title":"TargetListDeviceGroup","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"device_group_id":{"type":"string"},"target_list_id":{"type":"string"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/TargetListDeviceGroups_POST":{"id":"components/schemas/TargetListDeviceGroups_POST","kind":"json-schema","title":"TargetListDeviceGroups_POST","data":{"type":"object","properties":{"device_group_id":{"type":"string","format":"uuid","description":"UUID of the Device Group"}}}},"components/schemas/Device":{"id":"components/schemas/Device","kind":"json-schema","title":"Device","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the Device"},"device_name":{"type":"string","description":"Name of the device"},"serial":{"type":"string","description":"Device serial number"},"template_name":{"type":"string","description":"Device template name"},"manufacturer":{"type":"string","description":"Manufacturer of the Device"},"android_version":{"type":"string","description":"Version number of android"},"api_level":{"type":"string","description":"Device api level"},"is_gms":{"type":"boolean","description":"Is this a gms device"},"is_active":{"type":"boolean"},"model":{"type":"string","description":"Device model number"},"alias_name":{"type":"string","description":"Device alias"},"esper_client":{"type":"string"}}}},"components/schemas/Operation":{"id":"components/schemas/Operation","kind":"json-schema","title":"Operation","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"operation_list_id":{"type":"string"},"pipeline_id":{"type":"string"},"operation_type":{"type":"string"},"args":{"type":"string"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Operation_POST":{"id":"components/schemas/Operation_POST","kind":"json-schema","title":"Operation_POST","data":{"type":"object","properties":{"args":{"type":"object","description":"Arguments for the operation"},"operation_type":{"type":"string","enum":["LOCK","REBOOT","SET_NEW_POLICY","UPDATE_HEARTBEAT","REQUEST_BUGREPORT","REQUEST_DPCLOG","ADD_TO_WHITELIST","REMOVE_FROM_WHITELIST","SET_APP_PERMISSION","WIPE","CAPTURE_SCREENSHOT","SET_WIFI_STATE","SET_BLUETOOTH_STATE","SET_ROTATION_STATE","SET_GPS_STATE","SET_BRIGHTNESS_SCALE","SET_STREAM_VOLUME","SET_SCREEN_OFF_TIMEOUT","SET_ADB_STATE","INITIATE_OFFER","INSTALL","SIMPLE_INSTALL","UNINSTALL","REFRESH_APPLIST","UPDATE_LATEST_DPC","NOTIFY_OTA","CLEAR_APP_DATA","SET_GEO_FENCE","SET_KIOSK_APP","SET_DEVICE_LOCKDOWN_STATE","SET_TIMEZONE","SET_APP_STATE","ADD_WIFI_AP","REMOVE_WIFI_AP","UPDATE_DEVICE_CONFIG","INITIATE_CONFERENCE_CALL","ADD_OVERRIDE_APN","SYNC_CONTENT","SET_WALLPAPER"]}}}},"components/schemas/PipelineRun":{"id":"components/schemas/PipelineRun","kind":"json-schema","title":"PipelineRun","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"enterprise_id":{"type":"string","readOnly":true},"run_number":{"type":"integer","format":"int32","readOnly":true},"pipeline_id":{"type":"string"},"pipeline_name":{"type":"string"},"status":{"type":"string","enum":["pending","queued","processing","running","waiting","complete","success","failure","cancelled","invalid","timeout"]},"status_meta":{"type":"object"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"started_at":{"type":"string","format":"date-time"},"ended_at":{"type":"string","format":"date-time"}}}},"components/schemas/PipelineRun_POST":{"id":"components/schemas/PipelineRun_POST","kind":"json-schema","title":"PipelineRun_POST","data":{"type":"object"}},"components/schemas/PipelineRun_PUT":{"id":"components/schemas/PipelineRun_PUT","kind":"json-schema","title":"PipelineRun_PUT","data":{"type":"object","properties":{"status":{"type":"string","enum":["pending","queued","processing","running","waiting","complete","success","failure","cancelled","invalid","timeout"]}}}},"components/schemas/StageRun":{"id":"components/schemas/StageRun","kind":"json-schema","title":"StageRun","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"enterprise_id":{"type":"string","readOnly":true},"pipeline_id":{"type":"string"},"pipeline_run_id":{"type":"string"},"stage_id":{"type":"string"},"stage_meta":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"created_by":{"type":"number","format":"int32"}}},"status":{"type":"string","enum":["pending","queued","processing","running","complete","success","failure","cancelled","invalid","timeout"]},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"started_at":{"type":"string","format":"date-time"},"ended_at":{"type":"string","format":"date-time"}}}},"components/schemas/StageRunOperation":{"id":"components/schemas/StageRunOperation","kind":"json-schema","title":"StageRunOperation","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"operation_type":{"type":"string"},"args":{"type":"string"},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/TargetRun":{"id":"components/schemas/TargetRun","kind":"json-schema","title":"TargetRun","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"target_id":{"type":"string","format":"uuid"},"device_id":{"type":"string","format":"uuid"},"device_alias":{"type":"string","format":"uuid"},"stage_run_id":{"type":"string","format":"uuid"},"stage_run_operation_id":{"type":"string","format":"uuid"},"command_id":{"type":"string"},"command_status":{"type":"string"},"command_meta":{"type":"object"},"status":{"type":"string","enum":["pending","queued","processing","dispatched","running","complete","success","failure","cancelled","timeout","invalid"]},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"started_at":{"type":"string","format":"date-time"},"ended_at":{"type":"string","format":"date-time"}}}},"components/schemas/TargetRun_POST":{"id":"components/schemas/TargetRun_POST","kind":"json-schema","title":"TargetRun_POST","data":{"type":"object","properties":{"target_id":{"type":"string","format":"uuid"},"device_name":{"type":"string"},"device_alias":{"type":"string"}},"required":["target_id"]}},"components/schemas/TargetRun_PUT":{"id":"components/schemas/TargetRun_PUT","kind":"json-schema","title":"TargetRun_PUT","data":{"type":"object","properties":{"status":{"type":"string","enum":["pending","queued","processing","dispatched","running","complete","success","failure","cancelled","invalid"]},"device_name":{"type":"string"}}}},"components/schemas/CommandResponse":{"id":"components/schemas/CommandResponse","kind":"json-schema","title":"CommandResponse","data":{"type":"object","properties":{"target_run_id":{"type":"string","format":"uuid"},"operation_id":{"type":"string","format":"uuid"},"enterprise_id":{"type":"string","format":"uuid"},"command":{"type":"string"},"command_type":{"type":"string","default":"DEVICE"},"device_type":{"type":"string","default":"all"},"device_id":{"type":"string","format":"uuid"},"schedule":{"type":"string","default":"IMMEDIATE"},"args":{"type":"object"},"request_id":{"type":"string","format":"uuid"},"request_status":{"type":"string"},"request_status_reason":{"type":"string"}}}},"components/schemas/AndroidCommandRequest":{"id":"components/schemas/AndroidCommandRequest","kind":"json-schema","title":"AndroidCommandRequest","data":{"type":"object"}},"components/schemas/CommandRequest_PUT":{"id":"components/schemas/CommandRequest_PUT","kind":"json-schema","title":"CommandRequest_PUT","data":{"type":"object","properties":{"request_status":{"type":"string","enum":["cancelled"]}}}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"content":{"type":"object"}},"required":["code","message"]}},"components/schemas/Health":{"id":"components/schemas/Health","kind":"json-schema","title":"Health","data":{"type":"object","properties":{"service":{"type":"string"},"component":{"type":"string"},"hostname":{"type":"string"}},"required":["service","component","hostname"]}},"components/schemas/DeviceStateEnumAndroid":{"id":"components/schemas/DeviceStateEnumAndroid","kind":"json-schema","title":"DeviceStateEnumAndroid","data":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are the device states and their descriptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 30 = Beginning Provisioning\n* 40 = Configuring Google Play (still provisioning)\n* 50 = Applying Policies and Installing Applications (still provisioning)\n* 60 = Offline\n* 70 = Device is undergoing a Factory Reset (reset started from Dashboard)\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 110 = Android For Work Account added\n* 120 = Apps installed\n* 130 = Branding Processed\n* 140 = Permission Policy Processed\n* 150 = Device Policy Processed\n* 160 = Device Settings Processed\n* 170 = Security Policy Processed\n* 180 = Phone Policy Processed\n* 190 = Custom Settings Processed\n* 200 = Device is Registered\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 30 = Beginning Provisioning\n* 40 = Configuring Google Play (still provisioning)\n* 50 = Applying Policies and Installing Applications (still provisioning)\n* 60 = Offline\n* 70 = Device is undergoing a Factory Reset (reset started from Dashboard)\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 110 = Android For Work Account added\n* 120 = Apps installed\n* 130 = Branding Processed\n* 140 = Permission Policy Processed\n* 150 = Device Policy Processed\n* 160 = Device Settings Processed\n* 170 = Security Policy Processed\n* 180 = Phone Policy Processed\n* 190 = Custom Settings Processed\n* 200 = Device is Registered\n"},"children":[]}]}],"enum":[0,1,20,30,40,50,60,70,80,90,100,110,120,130,140,150,160,170,180,190,200]}},"components/schemas/HardwareInfo":{"id":"components/schemas/HardwareInfo","kind":"json-schema","title":"HardwareInfo","data":{"type":"object","properties":{"brand":{"type":"string","description":"The brand of the device"},"model":{"type":"string","description":"The model of the device"},"model_number":{"type":"string","description":"The model number of the device"},"serial":{"type":"string","description":"The serial number of the device"},"manufacturer":{"type":"string","description":"The manufacturer number of the device"},"hardware":{"type":"string","description":"The hardware information of the device"},"device_baseband_version":{"type":"string","description":"The device baseband version of the device"}}}},"components/schemas/FoundationInfo":{"id":"components/schemas/FoundationInfo","kind":"json-schema","title":"FoundationInfo","data":{"type":"object","properties":{"major_version":{"type":"string","description":"The foundation OS build major version of the device"},"minor_version":{"type":"string","description":"The foundation OS build minor version of the device"},"build_number":{"type":"string","description":"The foundation OS build number of the device"},"project_name":{"type":"string","description":"The foundation project name of the device"},"build_flavor":{"type":"string","description":"The foundation OS build flavor of the device"},"variant":{"type":"string","description":"The foundation variant of the device"},"foundation_device_model_id":{"type":"string","description":"The foundation device model id of the device"}}}},"components/schemas/AirwaveInfo":{"id":"components/schemas/AirwaveInfo","kind":"json-schema","title":"AirwaveInfo","data":{"type":"object","properties":{"build_number":{"type":"integer","description":"The airwave OS build number of the device"},"tenant_model_id":{"type":"string","description":"The airwave tenant model id of the device"},"build_id":{"type":"string","description":"The airwave build id of the device"},"esper_ota_manager_version_code":{"type":"integer","description":"The Esper OTA Manager version code"},"esper_ota_manager_version_name":{"type":"string","description":"The Esper OTA Manager version name"}}}},"components/schemas/SoftwareInfo":{"id":"components/schemas/SoftwareInfo","kind":"json-schema","title":"SoftwareInfo","data":{"type":"object","properties":{"os_version":{"type":"string","description":"The OS version number of the device"},"os_build_number":{"type":"string","description":"The OS build number of the device"},"bootloader_version":{"type":"string","description":"The bootloader version of the device"},"security_path_level":{"type":"string","description":"The security path level of the device"},"device_kernel_version":{"type":"string","description":"The kernel version of the device"},"eea_version":{"type":"string","description":"EEA (Esper Enterprise Android) version"},"esper_agent_info":{"type":"object","properties":{"version_code":{"type":"string","description":"Esper agent version code"},"version_name":{"type":"string","description":"Esper agent version name"}}},"foundation_info":{"$ref":"#/components/schemas/FoundationInfo"},"airwave_info":{"$ref":"#/components/schemas/AirwaveInfo"}}}},"components/schemas/NetworkInfo":{"id":"components/schemas/NetworkInfo","kind":"json-schema","title":"NetworkInfo","data":{"type":"object","properties":{"imei1":{"type":"string","description":"The IMEI number of the device"},"imei2":{"type":"string","description":"The IMEI number of the device"},"wifi_mac_address":{"type":"string","description":"The wifi mac address of the device"},"ethernet_mac_address":{"type":"string","description":"The ethernet mac address of the device"},"iccid1":{"type":"string","description":"The ICCID number of the device"},"iccid2":{"type":"string","description":"The ICCID number of the device"},"phone_number_1":{"type":"string","description":"The phone number of the device"},"phone_number_2":{"type":"string","description":"The phone number of the device"},"network_type":{"type":"string","description":"The network type of the device","enum":["CELLULAR","ETHERNET","WI-FI","OTHER"]}}}},"components/schemas/MemoryInfo":{"id":"components/schemas/MemoryInfo","kind":"json-schema","title":"MemoryInfo","data":{"type":"object","properties":{"total_ram":{"type":"string","description":"Total ram capacity for the device"},"total_internal_storage":{"type":"string","description":"The total internal storage capacity of the device"},"units":{"type":"string","description":"The units used for the storage capacity"},"internal_storage_binary_prefix":{"type":"string","description":"(Specific to Android devices)"}}}},"components/schemas/NetworkStats":{"id":"components/schemas/NetworkStats","kind":"json-schema","title":"NetworkStats","data":{"type":"object","properties":{"current_active_connection":{"type":"string","description":"The current active connection type"},"wifi_network_info":{"type":"object","properties":{"wifi_ssid":{"type":"string","description":"The SSID of the WiFi network"}}},"cellular_network_info":{"type":"object","properties":{"network_type":{"type":"string","description":"The network type of the cellular network - null, 2G, 3G, 4G LTE"}}}}}},"components/schemas/LocationStats":{"id":"components/schemas/LocationStats","kind":"json-schema","title":"LocationStats","data":{"type":"object","properties":{"altitude":{"type":"string","description":"The altitude value"},"latitude":{"type":"string","description":"The latitude value"},"longitude":{"type":"string","description":"The longitude value"}}}},"components/schemas/BlueprintInfo":{"id":"components/schemas/BlueprintInfo","kind":"json-schema","title":"BlueprintInfo","data":{"type":"object","properties":{"assigned_blueprint_id":{"type":"string","description":"Assigned blueprint id of the device"},"current_blueprint_id":{"type":"string","description":"Current blueprint id of the blueprint assigned to the device"},"current_blueprint_version_id":{"type":"string","description":"Current Version id of the blueprint assigned to the device"},"blueprint_upgrade_status":{"type":"string","description":"The status of the blueprint upgrade on the device","enum":["UPGRADABLE","UPGRADE_INITIATED","UPGRADE_FAILED","UPGRADED","NOT_UPGRADABLE","NOT_APPLICABLE"]}}}},"components/schemas/AndroidDevice":{"id":"components/schemas/AndroidDevice","kind":"json-schema","title":"AndroidDevice","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"alias":{"type":"string","description":"Alias/alternate name for the device"},"os":{"type":"string","description":"Operating system for the device","enum":["Android"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumAndroid"},"platform":{"type":"string","description":"Platform for the device","enum":["ANDROID"]},"serial":{"type":"string","description":"Serial number the device"},"os_version":{"type":"string","description":"OS version the device"},"global_device_id":{"type":"string","description":"Esper generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"onboarded_on":{"type":"string","format":"date-time"},"provisioned_on":{"type":"string","format":"date-time"},"hardware_info":{"$ref":"#/components/schemas/HardwareInfo"},"software_info":{"$ref":"#/components/schemas/SoftwareInfo"},"network_info":{"$ref":"#/components/schemas/NetworkInfo"},"memory_info":{"$ref":"#/components/schemas/MemoryInfo"},"network_stats":{"$ref":"#/components/schemas/NetworkStats"},"location_stats:":{"$ref":"#/components/schemas/LocationStats"},"blueprint_info":{"$ref":"#/components/schemas/BlueprintInfo"},"battery_stats":{"type":"object","properties":{"battery_level":{"type":"number","description":"Current battey level of the device"}}},"mqtt_topic":{"type":"string","description":"MQTT topic"},"fcm_id":{"type":"string"},"is_gms":{"type":"boolean"},"policy":{"nullable":true,"description":"Policy associated with the device","type":"object","properties":{"policy_id":{"type":"integer"},"policy_name":{"type":"string"}}},"managed_by":{"type":"string","description":"Whether the device is managed by blueprint or template","enum":["BLUEPRINT","TEMPLATE"]},"template_name":{"nullable":true,"type":"string","description":"Name of the template the device is managed by"},"is_seamless":{"type":"boolean"},"is_esper_managed":{"type":"boolean","nullable":true,"readOnly":true,"description":"Indicates if the device is Esper managed"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/DeviceStateEnumApple":{"id":"components/schemas/DeviceStateEnumApple","kind":"json-schema","title":"DeviceStateEnumApple","data":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are the device states and their descriptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online/Active\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 70 = Device is undergoing a Factory Reset (reset started from Dashboard)\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 200 = Device is Registered\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online/Active\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 70 = Device is undergoing a Factory Reset (reset started from Dashboard)\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 200 = Device is Registered\n"},"children":[]}]}],"enum":[0,1,20,70,80,90,100,200]}},"components/schemas/AppleDevice":{"id":"components/schemas/AppleDevice","kind":"json-schema","title":"AppleDevice","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"alias":{"type":"string","description":"Alias/alternate name for the device"},"os":{"type":"string","description":"Operating system for the device","enum":["iOS","iPadOS","tvOS"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumApple"},"platform":{"type":"string","description":"Platform for the device","enum":["APPLE"]},"serial":{"type":"string","description":"Serial number the device"},"os_version":{"type":"string","description":"OS version the device"},"global_device_id":{"type":"string","description":"Esper generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"hardware_info":{"$ref":"#/components/schemas/HardwareInfo"},"software_info":{"$ref":"#/components/schemas/SoftwareInfo"},"network_info":{"$ref":"#/components/schemas/NetworkInfo"},"memory_info":{"$ref":"#/components/schemas/MemoryInfo"},"blueprint_info":{"$ref":"#/components/schemas/BlueprintInfo"},"udid":{"type":"string","description":"UDID as provided by apple"},"dep_profile":{"type":"string","description":"DEP profile applied to device"},"dep_profile_push_time":{"type":"string","format":"date-time"},"dep_profile_assign_time":{"type":"string","format":"date-time"},"dep_profile_status":{"type":"string","description":"DEP profile applied to device","enum":["empty","assigned","pushed","removed"]},"enrolment_info":{"type":"object","properties":{"enrolment_id":{"type":"string","description":"The per-enrollment identifier for the device"},"enrolment_user_id":{"type":"string","description":"The per-enrollment identifier for the user"}}},"last_seen":{"type":"string","format":"date-time"},"tokens":{"type":"object","properties":{"push_magic":{"type":"string"},"push_token":{"type":"string"},"device_token":{"type":"string"}}},"device_source":{"type":"string","description":"Source of device onboarding","enum":["ABM","NON_ABM"]},"is_supervised":{"type":"boolean"},"is_ddm_enabled":{"type":"boolean","description":"Whether Declarative Device Management is enabled for this device"},"managed_by":{"type":"string","description":"Whether the device is managed by blueprint or template","enum":["BLUEPRINT"]},"onboarded_on":{"type":"string","format":"date-time"},"provisioned_on":{"type":"string","format":"date-time"},"is_seamless":{"type":"boolean"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/DeviceStateEnumLinux":{"id":"components/schemas/DeviceStateEnumLinux","kind":"json-schema","title":"DeviceStateEnumLinux","data":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are the device states and their descriptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online/Active\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 70 = Device Wipe in Progress\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 200 = Device is Registered\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online/Active\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 70 = Device Wipe in Progress\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 200 = Device is Registered\n"},"children":[]}]}],"enum":[0,1,20,70,80,90,100,200]}},"components/schemas/LinuxBlueprintInfo":{"id":"components/schemas/LinuxBlueprintInfo","kind":"json-schema","title":"LinuxBlueprintInfo","data":{"type":"object","properties":{"assigned_blueprint_id":{"type":"string","description":"Assigned blueprint id of the device"},"current_blueprint_id":{"type":"string","description":"Current blueprint id of the blueprint assigned to the device"},"current_blueprint_version_id":{"type":"string","description":"Current Version id of the blueprint assigned to the device"},"blueprint_upgrade_status":{"type":"string","description":"The status of the blueprint upgrade on the device","enum":["NOT_APPLICABLE"]}}}},"components/schemas/LinuxDevice":{"id":"components/schemas/LinuxDevice","kind":"json-schema","title":"LinuxDevice","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"os":{"type":"string","description":"Operating system for the device","enum":["Ubuntu"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumLinux"},"platform":{"type":"string","description":"Operating system for the device","enum":["LINUX"]},"serial":{"type":"string","description":"Serial number the device"},"os_version":{"type":"string","description":"OS version the device"},"global_device_id":{"type":"string","description":"Esper generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"onboarded_on":{"type":"string","format":"date-time"},"provisioned_on":{"type":"string","format":"date-time"},"blueprint_info":{"$ref":"#/components/schemas/LinuxBlueprintInfo"},"managed_by":{"type":"string","description":"Whether the device is managed by blueprint or template","enum":["BLUEPRINT"]},"is_seamless":{"type":"boolean"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/DeviceStateEnumWindows":{"id":"components/schemas/DeviceStateEnumWindows","kind":"json-schema","title":"DeviceStateEnumWindows","data":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are the device states and their descriptions:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online/Active\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 70 = Device Wipe in Progress\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 200 = Device is Registered\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* 0 = Device State is Unspecified\n* 1 = Online/Active\n* 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)\n* 70 = Device Wipe in Progress\n* 80 = Device Onboarding in Progress\n* 90 = Device Onboarding Failed\n* 100 = Device Onboarded in Esper\n* 200 = Device is Registered\n"},"children":[]}]}],"enum":[0,1,20,70,80,90,100,200]}},"components/schemas/WindowsDevice":{"id":"components/schemas/WindowsDevice","kind":"json-schema","title":"WindowsDevice","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"os":{"type":"string","description":"Operating system of the device","enum":["Windows"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumWindows"},"platform":{"type":"string","description":"Operating system of the device","enum":["WINDOWS"]},"serial":{"type":"string","description":"Serial number of the device"},"os_version":{"type":"string","description":"OS version of the device"},"global_device_id":{"type":"string","description":"Windows generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"onboarded_on":{"type":"string","format":"date-time"},"provisioned_on":{"type":"string","format":"date-time"},"blueprint_info":{"$ref":"#/components/schemas/BlueprintInfo"},"managed_by":{"type":"string","description":"Whether the device is managed by blueprint or template","enum":["BLUEPRINT"]},"is_seamless":{"type":"boolean"},"windows_config":{"type":"object","properties":{"channel_uri":{"type":"string","description":"Channel URI for the device"},"channel_updated_at":{"type":"string","format":"date-time","description":"Last updated time of the channel URI"}}},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Error_404_Not_Found":{"id":"components/schemas/Error_404_Not_Found","kind":"json-schema","title":"Error_404_Not_Found","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","default":404},"message":{"type":"string"},"content":{"type":"object"}},"required":["code","message"]}},"components/schemas/DeviceSettings":{"id":"components/schemas/DeviceSettings","kind":"json-schema","title":"DeviceSettings","data":{"type":"object","properties":{"gps_state":{"type":"string","description":"GPS state of the device","enum":["LOCATION_MODE_HIGH_ACCURACY","LOCATION_MODE_SENSORS_ONLY","LOCATION_MODE_BATTERY_SAVING","LOCATION_MODE_OFF","LOCATION_MODE_ON"]},"wifi_state":{"type":"boolean","description":"WiFi state of the device"},"adb_enabled":{"type":"boolean","description":"ADB state of the device"},"adb_timeout":{"type":"integer","description":"ADB timeout value for the device"},"remote_adb_enabled":{"type":"boolean","description":"Remote ADB state for the device"},"remote_adb_ip":{"type":"string","description":"Remote ADB IP for the device"},"remote_adb_port":{"type":"integer","description":"Remote ADB port for the device"},"audio_settings":{"type":"object","description":"Different Audio types and respective values"},"rotation_state":{"type":"string","description":"Display rotation of the device","enum":["AUTO","PORTRAIT_ONLY","LANDSCAPE_ONLY","INVERTED_PORTRAIT_ONLY","INVERTED_LANDSCAPE_ONLY"]},"bluetooth_state":{"type":"boolean","description":"Bluetooth state of device"},"brightness_scale":{"type":"integer","description":"Brightess value for the device it will be in range 0 to 100"},"screen_off_timeout":{"type":"integer","description":"Device screen off timeout"},"use_only_saved_ap":{"type":"boolean","description":"Whether device is allowed to connect to only saved Wifi APs"}}}},"components/schemas/NetworkStatsV2":{"id":"components/schemas/NetworkStatsV2","kind":"json-schema","title":"NetworkStatsV2","data":{"type":"object","properties":{"current_active_connection":{"type":"string","description":"The current active connection type"},"wifi_network_info":{"type":"object","properties":{"wifi_ssid":{"type":"string","description":"The SSID of the WiFi network"},"wifi_signal_strength":{"type":"integer","description":"The signal strength of the WiFi network on a scale of 0 to 5"}}},"cellular_network_info":{"type":"object","properties":{"network_type":{"type":"string","description":"The network type of the cellular network - null, 2G, 3G, 4G LTE"}}},"ip_address":{"type":"array","items":{"type":"string"},"description":"The IP address of the device"}}}},"components/schemas/MemoryStats":{"id":"components/schemas/MemoryStats","kind":"json-schema","title":"MemoryStats","data":{"type":"object","properties":{"available_ram":{"type":"integer","description":"The available memory value"},"available_internal_storage":{"type":"integer","description":"The available internal storage value"},"os_occupied_storage":{"type":"integer","description":"The OS occupied storage value"}}}},"components/schemas/AndroidDeviceV2":{"id":"components/schemas/AndroidDeviceV2","kind":"json-schema","title":"AndroidDeviceV2","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"alias":{"type":"string","description":"Alias/alternate name for the device"},"os":{"type":"string","description":"Operating system for the device","enum":["Android"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumAndroid"},"platform":{"type":"string","description":"Platform for the device","enum":["ANDROID"]},"serial":{"type":"string","description":"Serial number the device"},"os_version":{"type":"string","description":"OS version the device"},"global_device_id":{"type":"string","description":"Esper generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"provisioned_on":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of UUIDs representing tags associated with the device"},"hardware_info":{"$ref":"#/components/schemas/HardwareInfo"},"software_info":{"$ref":"#/components/schemas/SoftwareInfo"},"network_info":{"$ref":"#/components/schemas/NetworkInfo"},"memory_info":{"$ref":"#/components/schemas/MemoryInfo"},"network_stats":{"$ref":"#/components/schemas/NetworkStatsV2"},"location_stats":{"$ref":"#/components/schemas/LocationStats"},"memory_stats":{"$ref":"#/components/schemas/MemoryStats"},"blueprint_info":{"$ref":"#/components/schemas/BlueprintInfo"},"battery_stats":{"type":"object","properties":{"battery_level":{"type":"number","description":"Current battey level of the device"}}},"mqtt_topic":{"type":"string","description":"MQTT topic"},"fcm_id":{"type":"string"},"is_gms":{"type":"boolean"},"dpc_version":{"nullable":true,"type":"string","description":"DPC (Device Policy Controller) version / Esper agent version name"},"eea_version":{"nullable":true,"type":"string","description":"EEA (Esper Enterprise Android) version"},"policy":{"nullable":true,"description":"Policy associated with the device","type":"object","properties":{"policy_id":{"type":"integer"},"policy_name":{"type":"string"}}},"managed_by":{"type":"string","description":"Whether the device is managed by blueprint or template","enum":["BLUEPRINT","TEMPLATE"]},"provisioned_with":{"type":"string","description":"Whether the device was provisioned with blueprint or template","enum":["BLUEPRINT","TEMPLATE"]},"template_name":{"nullable":true,"type":"string","description":"Name of the template the device is managed by"},"is_seamless":{"type":"boolean"},"is_esper_managed":{"type":"boolean","nullable":true,"readOnly":true,"description":"Indicates if the device is Esper managed"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/AppleDeviceV2":{"id":"components/schemas/AppleDeviceV2","kind":"json-schema","title":"AppleDeviceV2","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"alias":{"type":"string","description":"Alias/alternate name for the device"},"os":{"type":"string","description":"Operating system for the device","enum":["iOS","iPadOS","tvOS"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumApple"},"platform":{"type":"string","description":"Platform for the device","enum":["APPLE"]},"serial":{"type":"string","description":"Serial number the device"},"os_version":{"type":"string","description":"OS version the device"},"global_device_id":{"type":"string","description":"Esper generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of UUIDs representing tags associated with the device"},"hardware_info":{"$ref":"#/components/schemas/HardwareInfo"},"software_info":{"$ref":"#/components/schemas/SoftwareInfo"},"network_info":{"$ref":"#/components/schemas/NetworkInfo"},"memory_info":{"$ref":"#/components/schemas/MemoryInfo"},"blueprint_info":{"$ref":"#/components/schemas/BlueprintInfo"},"udid":{"type":"string","description":"UDID as provided by apple"},"dep_profile":{"type":"string","description":"DEP profile applied to device"},"dep_profile_push_time":{"type":"string","format":"date-time"},"dep_profile_assign_time":{"type":"string","format":"date-time"},"dep_profile_status":{"type":"string","description":"DEP profile applied to device","enum":["empty","assigned","pushed","removed"]},"enrolment_info":{"type":"object","properties":{"enrolment_id":{"type":"string","description":"The per-enrollment identifier for the device"},"enrolment_user_id":{"type":"string","description":"The per-enrollment identifier for the user"}}},"last_seen":{"type":"string","format":"date-time"},"tokens":{"type":"object","properties":{"push_magic":{"type":"string"},"push_token":{"type":"string"},"device_token":{"type":"string"}}},"is_supervised":{"type":"boolean"},"device_source":{"type":"string","description":"Source of device onboarding","enum":["ABM","NON_ABM"]},"managed_by":{"type":"string","description":"Whether the device is managed by blueprint or template","enum":["BLUEPRINT"]},"provisioned_with":{"type":"string","description":"Whether the device was provisioned with blueprint or template","enum":["BLUEPRINT"]},"provisioned_on":{"type":"string","format":"date-time"},"is_seamless":{"type":"boolean"},"is_locked_down":{"type":"boolean"},"is_ddm_enabled":{"type":"boolean","description":"Whether Declarative Device Management is enabled for this device"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"memory_stats":{"type":"object","properties":{"total_memory":{"type":"integer","format":"int64","description":"Total memory in bytes"},"total_internal_storage":{"type":"integer","format":"int64","description":"Total internal storage in bytes"},"available_ram":{"type":"integer","format":"int64","description":"Available RAM in bytes"},"available_internal_storage":{"type":"integer","format":"int64","description":"Available internal storage in bytes"}}},"battery_stats":{"type":"object","properties":{"battery_level":{"type":"number","description":"Current battery level of the device"}}},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/LinuxDeviceV2":{"id":"components/schemas/LinuxDeviceV2","kind":"json-schema","title":"LinuxDeviceV2","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"alias":{"type":"string","description":"Alias/alternate name for the device"},"os":{"type":"string","description":"Operating system for the device","enum":["ubuntu","Ubuntu","Linux"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumLinux"},"platform":{"type":"string","description":"Platform for the device","enum":["LINUX"]},"serial":{"type":"string","description":"Serial number the device"},"os_version":{"type":"string","description":"OS version the device"},"global_device_id":{"type":"string","description":"Esper generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"provisioned_on":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of UUIDs representing tags associated with the device"},"hardware_info":{"type":"object","properties":{"brand":{"type":"string","description":"Device brand"},"model":{"type":"string","description":"Device model"},"serial":{"type":"string","description":"Device serial number"},"manufacturer":{"type":"string","description":"Device manufacturer"},"hardware":{"type":"string","description":"Hardware information"}}},"software_info":{"type":"object","properties":{"supported_abi":{"type":"string","description":"Supported ABI"},"os_build_time":{"type":"integer","format":"int64","description":"OS build time timestamp"},"os_build_number":{"type":"string","description":"OS build number"},"os_version":{"type":"string","description":"OS version"},"os":{"type":"string","description":"OS name"},"os_platform":{"type":"string","description":"OS platform"},"os_distribution":{"type":"string","description":"OS distribution"},"bootloader_version":{"type":"string","description":"Bootloader version"},"kernel_architecture":{"type":"string","description":"Kernel architecture"},"device_kernel_version":{"type":"string","description":"Device kernel version"},"last_boot_time":{"type":"string","description":"Last boot time"},"display_resolution":{"type":"string","description":"Display resolution"},"display_refresh_rate":{"type":"string","description":"Display refresh rate"},"esper_agent_info":{"type":"object","properties":{"version_code":{"type":"string","description":"Esper agent version code"},"version_name":{"type":"string","description":"Esper agent version name"}}}}},"network_info":{"type":"object","properties":{"wifi_mac_address":{"type":"string","description":"Wi-Fi MAC address"},"ethernet_mac_address":{"type":"string","description":"Ethernet MAC address"}}},"memory_info":{"type":"object","properties":{"total_ram":{"type":"string","description":"Total RAM in bytes"},"total_internal_storage":{"type":"string","description":"Total internal storage in bytes"},"total_swap_memory":{"type":"string","description":"Total swap memory in bytes"},"units":{"type":"string","description":"Units used for the storage capacity"}}},"network_stats":{"type":"object","properties":{"dns_servers":{"type":"array","items":{"type":"string"},"description":"DNS servers"},"default_gateway":{"type":"string","description":"Default gateway"},"ethernet_ip_address":{"type":"string","description":"Ethernet IP address"},"current_active_connection":{"type":"string","description":"The current active connection type"},"wifi_network_info":{"type":"object","properties":{"wifi_ssid":{"type":"string","description":"The SSID of the WiFi network"},"wifi_signal_strength":{"type":"integer","description":"The signal strength of the WiFi network"},"wifi_ip_address":{"type":"string","description":"The IP address of the WiFi network"}}},"ip_address":{"type":"array","items":{"type":"string"},"description":"The IP address of the device"}}},"memory_stats":{"type":"object","properties":{"total_memory":{"type":"integer","format":"int64","description":"Total memory in bytes"},"total_internal_storage":{"type":"integer","format":"int64","description":"Total internal storage in bytes"},"total_swap_memory":{"type":"integer","format":"int64","description":"Total swap memory in bytes"},"available_ram":{"type":"integer","format":"int64","description":"The available memory value"},"available_internal_storage":{"type":"integer","format":"int64","description":"The available internal storage value"},"available_swap_memory":{"type":"integer","format":"int64","description":"The available swap memory value"},"units":{"type":"string","description":"The units used for the storage capacity"}}},"cpu_stats":{"type":"object","properties":{"cpu_counts":{"type":"integer","description":"Number of CPU cores"},"cpu_cores":{"type":"array","items":{"type":"number","format":"float"},"description":"CPU core usage percentages"},"cpu_temperature":{"type":"number","format":"float","description":"CPU temperature"},"total_percent":{"type":"number","format":"float","description":"Total CPU usage percentage"}}},"battery_stats":{"type":"object","properties":{"battery_present":{"type":"boolean","description":"Whether battery is present"},"battery_state":{"type":"string","description":"Battery state"},"battery_energy":{"type":"number","format":"float","description":"Battery energy"},"battery_energy_full":{"type":"number","format":"float","description":"Battery full energy"},"battery_energy_full_design":{"type":"number","format":"float","description":"Battery design full energy"},"battery_level":{"type":"number","format":"int32","description":"Battery level"},"battery_technology":{"type":"string","description":"Battery technology"},"battery_voltage":{"type":"number","format":"float","description":"Battery voltage"},"battery_health":{"type":"number","format":"float","description":"Battery health percentage"},"battery_temperature":{"type":"number","format":"float","description":"Battery temperature"}}},"location_stats":{"type":"object","properties":{"latitude":{"type":"number","format":"float","description":"Device latitude"},"longitude":{"type":"number","format":"float","description":"Device longitude"},"altitude":{"type":"number","format":"float","description":"Device altitude"},"accuracy":{"type":"number","format":"float","description":"Location accuracy"}}},"blueprint_info":{"$ref":"#/components/schemas/LinuxBlueprintInfo"},"managed_by":{"type":"string","description":"Whether the device is managed by blueprint or template","enum":["BLUEPRINT"]},"provisioned_with":{"type":"string","description":"Whether the device was provisioned with blueprint or template","enum":["BLUEPRINT"]},"is_seamless":{"type":"boolean"},"last_seen":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/WindowsBlueprintInfo":{"id":"components/schemas/WindowsBlueprintInfo","kind":"json-schema","title":"WindowsBlueprintInfo","data":{"type":"object","properties":{"assigned_blueprint_id":{"type":"string","description":"Assigned blueprint id of the device"},"current_blueprint_id":{"type":"string","description":"Current blueprint id of the blueprint assigned to the device"},"current_blueprint_version_id":{"type":"string","description":"Current Version id of the blueprint assigned to the device"},"blueprint_upgrade_status":{"type":"string","description":"The status of the blueprint upgrade on the device","enum":["NOT_APPLICABLE"]}}}},"components/schemas/WindowsDeviceV2":{"id":"components/schemas/WindowsDeviceV2","kind":"json-schema","title":"WindowsDeviceV2","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","description":"Esper generated name for the device"},"alias":{"type":"string","description":"Alias/alternate name for the device"},"os":{"type":"string","description":"Operating system for the device","enum":["Windows"]},"state":{"$ref":"#/components/schemas/DeviceStateEnumWindows"},"platform":{"type":"string","description":"Platform for the device","enum":["WINDOWS"]},"serial":{"type":"string","description":"Serial number the device"},"os_version":{"type":"string","description":"OS version the device"},"global_device_id":{"type":"string","description":"Windows generated unique id for the device"},"tenant_id":{"type":"string","format":"uuid","readOnly":true},"group_id":{"type":"string","format":"uuid","readOnly":true},"provisioned_on":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of UUIDs representing tags associated with the device"},"hardware_info":{"type":"object","properties":{"brand":{"type":"string","description":"Device brand"},"model":{"type":"string","description":"Device model"},"serial":{"type":"string","description":"Device serial number"},"manufacturer":{"type":"string","description":"Device manufacturer"},"hardware":{"type":"string","description":"Hardware information"}}},"software_info":{"type":"object","properties":{"os_build_number":{"type":"string","description":"OS build number"},"os_version":{"type":"string","description":"OS version"},"os":{"type":"string","description":"OS name"},"bootloader_version":{"type":"string","description":"Bootloader version"},"kernel_architecture":{"type":"string","description":"Kernel architecture"},"device_kernel_version":{"type":"string","description":"Device kernel version"},"esper_agent_info":{"type":"object","properties":{"version_code":{"type":"string","description":"Esper agent version code"},"version_name":{"type":"string","description":"Esper agent version name"}}}}},"network_info":{"type":"object","properties":{"wifi_mac_address":{"type":"string","description":"Wi-Fi MAC address"},"ethernet_mac_address":{"type":"string","description":"Ethernet MAC address"}}},"memory_info":{"type":"object","properties":{"total_ram":{"type":"string","description":"Total RAM in bytes"},"total_internal_storage":{"type":"string","description":"Total internal storage in bytes"},"units":{"type":"string","description":"Units used for the storage capacity"}}},"network_stats":{"type":"object","properties":{"dns_servers":{"type":"array","items":{"type":"string"},"description":"DNS servers"},"default_gateway":{"type":"string","description":"Default gateway"},"ethernet_ip_address":{"type":"string","description":"Ethernet IP address"},"current_active_connection":{"type":"string","description":"The current active connection type"},"wifi_network_info":{"type":"object","properties":{"wifi_ssid":{"type":"string","description":"The SSID of the WiFi network"},"wifi_signal_strength":{"type":"integer","description":"The signal strength of the WiFi network"},"wifi_ip_address":{"type":"string","description":"The IP address of the WiFi network"}}},"ip_address":{"type":"array","items":{"type":"string"},"description":"The IP address of the device"}}},"memory_stats":{"type":"object","properties":{"total_memory":{"type":"integer","format":"int64","description":"Total memory in bytes"},"total_internal_storage":{"type":"integer","format":"int64","description":"Total internal storage in bytes"},"available_ram":{"type":"integer","format":"int64","description":"The available memory value"},"available_internal_storage":{"type":"integer","format":"int64","description":"The available internal storage value"},"units":{"type":"string","description":"The units used for the storage capacity"}}},"cpu_stats":{"type":"object","properties":{"cpu_counts":{"type":"integer","description":"Number of CPU cores"},"cpu_cores":{"type":"array","items":{"type":"number","format":"float"},"description":"CPU core usage percentages"},"cpu_temperature":{"type":"number","format":"float","description":"CPU temperature"}}},"last_seen":{"type":"string","format":"date-time","description":"Last time the device was seen"},"blueprint_info":{"$ref":"#/components/schemas/WindowsBlueprintInfo"},"battery_stats":{"type":"object","properties":{"battery_level":{"type":"number","description":"Current battery level of the device"}}},"provisioned_with":{"type":"string","description":"Whether the device was provisioned with blueprint or template","enum":["BLUEPRINT"]},"is_seamless":{"type":"boolean"},"windows_config":{"type":"object","properties":{"channel_uri":{"type":"string","description":"Channel URI for the device"},"channel_updated_at":{"type":"string","format":"date-time","description":"Last updated time of the channel URI"}}},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/OffsetPaginatedDeviceList":{"id":"components/schemas/OffsetPaginatedDeviceList","kind":"json-schema","title":"OffsetPaginatedDeviceList","data":{"type":"object","description":"Response format for offset-based pagination","properties":{"count":{"type":"integer","description":"Total number of devices matching the query"},"previous":{"type":"string","nullable":true,"description":"URL to the previous page of results"},"next":{"type":"string","nullable":true,"description":"URL to the next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AndroidDeviceV2"},{"$ref":"#/components/schemas/AppleDeviceV2"},{"$ref":"#/components/schemas/LinuxDeviceV2"},{"$ref":"#/components/schemas/WindowsDeviceV2"}]}}}}},"components/schemas/CursorPaginatedDeviceList":{"id":"components/schemas/CursorPaginatedDeviceList","kind":"json-schema","title":"CursorPaginatedDeviceList","data":{"type":"object","description":"Response format for cursor-based pagination","properties":{"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AndroidDeviceV2"},{"$ref":"#/components/schemas/AppleDeviceV2"},{"$ref":"#/components/schemas/LinuxDeviceV2"},{"$ref":"#/components/schemas/WindowsDeviceV2"}]}},"next_cursor":{"type":"string","nullable":true,"description":"Opaque cursor token for fetching the next page. Null if no more results.","example":"eyJzdiI6W3siYyI6InVwZGF0ZWRfYXQiLCJ2IjoiMjAyNi0wMy0xMVQwNzozNjowMS45NDM3NDlaIiwibyI6IkRFU0MifV0sInV2IjoiMTM5NzQwMjYtYTQzNS00ZDk5LWEyOWItM2E0Y2Y0MTZmODFhIn0="},"prev_cursor":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque cursor token for navigating to the previous page. Pass this value as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to paginate backward. Null when already on the first page."},"children":[]}]}]}]},"has_more":{"type":"boolean","description":"Indicates if there are more results after the current page"},"has_prev":{"type":"boolean","description":"Indicates if there are results before the current page"}}}},"components/schemas/EsperDeviceHeartbeat":{"id":"components/schemas/EsperDeviceHeartbeat","kind":"json-schema","title":"EsperDeviceHeartbeat","data":{"type":"object","properties":{"device_id":{"type":"string","description":"UUID of the device","format":"uuid"},"timestamp":{"type":"string","description":"Last seen time stamp of the device","format":"date-time"},"status":{"type":"integer","description":"Legacy field representing whether the device was last seen in the last 30 minutes (returns 1) or not (returns 0). ","enum":[0,1]}}}},"components/schemas/DeviceLastSeen":{"id":"components/schemas/DeviceLastSeen","kind":"json-schema","title":"DeviceLastSeen","data":{"type":"object","properties":{"count":{"type":"integer"},"prev":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EsperDeviceHeartbeat"}}}}},"components/schemas/DeviceAppsResponse":{"id":"components/schemas/DeviceAppsResponse","kind":"json-schema","title":"DeviceAppsResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"device_id":{"type":"string","format":"uuid"},"app_id":{"type":"string","format":"uuid"},"app_type":{"type":"string","enum":["TENANT_IOS","ESPER_IOS","ESPER_WINDOWS","TENANT_WINDOWS"]},"app_version_id":{"type":"string","format":"uuid"},"base64_app_config":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tenant_id":{"type":"string","format":"uuid"}}}},"components/schemas/AutoInstallConstraint":{"id":"components/schemas/AutoInstallConstraint","kind":"json-schema","title":"AutoInstallConstraint","data":{"type":"object","properties":{"charging_state_constraint":{"type":"string","description":"Constraint on the device's charging state for installation."},"device_idle_state_constraint":{"type":"string","description":"Constraint on the device's idle state for installation."},"network_type_constraint":{"type":"string","description":"Network type required for installation."}}}},"components/schemas/AutoInstallPolicy":{"id":"components/schemas/AutoInstallPolicy","kind":"json-schema","title":"AutoInstallPolicy","data":{"type":"object","properties":{"auto_install_constraint":{"type":"array","items":{"$ref":"#/components/schemas/AutoInstallConstraint"},"description":"Constraints for auto-installing the product."},"auto_install_mode":{"type":"string","description":"Mode for auto-installation."},"auto_install_priority":{"type":"integer","description":"Priority of the auto-installation."}}}},"components/schemas/VariableSet":{"id":"components/schemas/VariableSet","kind":"json-schema","title":"VariableSet","data":{"type":"object","properties":{"placeholder":{"type":"string","description":"Placeholder key for configuration variable.","example":"$emailaddress$"},"user_value":{"type":"string","description":"User-provided value for the placeholder.","example":"user@example.com"}}}},"components/schemas/ManagedConfiguration":{"id":"components/schemas/ManagedConfiguration","kind":"json-schema","title":"ManagedConfiguration","data":{"type":"object","properties":{"configuration_variables":{"type":"object","description":"Variables used for managed configurations.","properties":{"mcm_id":{"type":"string","description":"MCM ID required for configuration management.","example":"00982462290877382272"},"variable_set":{"type":"array","description":"Set of configuration variables and their values.","items":{"$ref":"#/components/schemas/VariableSet"}}}},"kind":{"type":"string","description":"Type of managed configuration.","example":"androidenterprise#managedConfiguration"}}}},"components/schemas/ProductPolicy":{"id":"components/schemas/ProductPolicy","kind":"json-schema","title":"ProductPolicy","data":{"type":"object","properties":{"auto_update_mode":{"type":"string","description":"Mode of auto-updating the product."},"product_id":{"type":"string","description":"Unique identifier for the product."},"auto_install_policy":{"$ref":"#/components/schemas/AutoInstallPolicy"},"managed_configuration":{"$ref":"#/components/schemas/ManagedConfiguration"}}}},"components/schemas/Policy":{"id":"components/schemas/Policy","kind":"json-schema","title":"Policy","data":{"type":"object","properties":{"auto_update_policy":{"type":"string","description":"Defines the auto-update policy for the device."},"device_report_policy":{"type":"string","description":"Policy for device report generation."},"product_availability_policy":{"type":"string","description":"Defines the product availability policy."},"product_policy":{"type":"array","items":{"$ref":"#/components/schemas/ProductPolicy"}}}}},"components/schemas/GoogleEMMDevice":{"id":"components/schemas/GoogleEMMDevice","kind":"json-schema","title":"GoogleEMMDevice","data":{"type":"object","properties":{"android_id":{"type":"string","description":"Unique identifier for the Android device."},"management_type":{"type":"string","description":"The management type of the device (e.g., managedDevice)."},"policy":{"$ref":"#/components/schemas/Policy"}}}},"components/schemas/GoogleApplication":{"id":"components/schemas/GoogleApplication","kind":"json-schema","title":"GoogleApplication","data":{"type":"object","properties":{"product_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique product ID in the format of app:<package_name>."},"children":[]}]}]}],"example":"app:com.android.chrome"},"mcm_id":{"type":"string","description":"The MCM ID if required for configuration management.","example":"mcm_12345"},"app_action":{"type":"string","description":"Action to be performed on the app, either 'install' or 'uninstall'.","enum":["install","uninstall"],"example":"install"}}}},"components/schemas/GoogleEMMDevicePolicyRequest":{"id":"components/schemas/GoogleEMMDevicePolicyRequest","kind":"json-schema","title":"GoogleEMMDevicePolicyRequest","data":{"type":"object","properties":{"applications":{"type":"array","items":{"$ref":"#/components/schemas/GoogleApplication"}}}}},"components/schemas/GoogleDevice":{"id":"components/schemas/GoogleDevice","kind":"json-schema","title":"GoogleDevice","data":{"type":"object","properties":{"androidId":{"type":"string","description":"The Google Play Services Android ID for the device encoded as a lowercase hex string. For example, '123456789abcdef0'."},"managementType":{"type":"string","description":"The type of management applied to the device, such as 'enterprise' or 'work'."}}}},"components/schemas/DevicesListResponse":{"id":"components/schemas/DevicesListResponse","kind":"json-schema","title":"DevicesListResponse","data":{"type":"object","properties":{"device":{"type":"array","items":{"$ref":"#/components/schemas/GoogleDevice"}}}}},"components/schemas/GoogleAccount":{"id":"components/schemas/GoogleAccount","kind":"json-schema","title":"GoogleAccount","data":{"type":"object","properties":{"tenant_id":{"type":"string","format":"uuid","description":"The ID of the tenant associated with the Google account."},"google_user_id":{"type":"string","description":"The unique identifier for the Google user."},"device_id":{"type":"string","format":"uuid","description":"The ID of the device associated with the Google account."},"google_device_id":{"type":"string","description":"The unique identifier for the Google device."},"account_identifier":{"type":"string","description":"An identifier for the account."},"account_type":{"type":"integer","description":"The type of the Google account."},"google_authentication_token":{"type":"string","description":"The authentication token for the Google account."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the Google account was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the Google account was last updated."}},"required":["tenant_id","google_user_id","device_id","account_type"]}},"components/schemas/GoogleAccountUpdateRequestBody":{"id":"components/schemas/GoogleAccountUpdateRequestBody","kind":"json-schema","title":"GoogleAccountUpdateRequestBody","data":{"type":"object","properties":{"google_device_id":{"type":"string","description":"Unique identifier for the Google device."},"google_user_id":{"type":"string","description":"Unique identifier for the Google user."}},"required":["google_device_id","google_user_id"]}},"components/schemas/GoogleAccountUpdateResponseBody":{"id":"components/schemas/GoogleAccountUpdateResponseBody","kind":"json-schema","title":"GoogleAccountUpdateResponseBody","data":{"type":"object","properties":{"device_id":{"type":"string","description":"Unique identifier for the device."},"tenant_id":{"type":"string","description":"Unique identifier for the tenant."}},"required":["device_id","tenant_id"]}},"components/schemas/Error_409_Conflict":{"id":"components/schemas/Error_409_Conflict","kind":"json-schema","title":"Error_409_Conflict","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","default":409},"message":{"type":"string"},"content":{"type":"object"}},"required":["code","message"]}},"components/schemas/OperationScheduleArgsTimeTypeEnum":{"id":"components/schemas/OperationScheduleArgsTimeTypeEnum","kind":"json-schema","title":"OperationScheduleArgsTimeTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Time-Type argument, in Schedule args, is to indicate which timezone the Command Framework should utilize when scheduling the command."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule Args for Time-Type are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* CONSOLE: Use the local timezone of the user creating the schedule.\n* DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* CONSOLE: Use the local timezone of the user creating the schedule.\n* DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be.\n"},"children":[]}]}],"enum":["console","device"]}},"components/schemas/ScheduleArgs":{"id":"components/schemas/ScheduleArgs","kind":"json-schema","title":"ScheduleArgs","data":{"type":"object","properties":{"start_datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date and time in ISO 8601 format, including timezone (e.g., 2024-08-08T14:30:00Z or 2024-08-08T14:30:00+05:30)."},"children":[]}]}]}]},"end_datetime":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date and time in ISO 8601 format, including timezone (e.g., 2024-08-08T15:30:00Z or 2024-08-08T15:30:00+05:30)."},"children":[]}]}]}]},"time_type":{"$ref":"#/components/schemas/OperationScheduleArgsTimeTypeEnum"},"window_start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is automatically populated by the time field from the request's start_datetime and cannot be injected via the API request body."},"children":[]}]}]}]},"window_end_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is automatically populated by the time field from the request's end_datetime and cannot be injected via the API request body."},"children":[]}]}]}]},"days":{"type":"array","items":{"type":"integer"}}}}},"components/schemas/OperationActivity":{"id":"components/schemas/OperationActivity","kind":"json-schema","title":"OperationActivity","data":{"type":"array","items":{"type":"object","properties":{"operation_state":{"type":"string","enum":["CREATED","QUERY INITIATED","QUERY RESOLVED","DISPATCHING","DISPATCHED","PROCESSING","SUCCESS","FAILURE"]},"created_at":{"type":"string","format":"date-time"}}}}},"components/schemas/OperationStats":{"id":"components/schemas/OperationStats","kind":"json-schema","title":"OperationStats","data":{"type":"object","properties":{"device_operation_statuses_count":{"type":"object","properties":{"resolved_device_count":{"type":"integer"},"dispatched_device_count":{"type":"integer"},"dispatch_failed_count":{"type":"integer"},"failed_device_count":{"type":"integer"},"success_device_count":{"type":"integer"}}}}}},"components/schemas/OperationWithStats":{"id":"components/schemas/OperationWithStats","kind":"json-schema","title":"OperationWithStats","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"operation":{"type":"string","description":"","enum":["CONVERGE"]},"state":{"type":"string","description":"","enum":["CREATED","RESOLVING","RESOLVED","DISPATCHING","COMPLETED","FAILED"]},"schedule_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule types are supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n"},"children":[]}]}],"enum":["IMMEDIATE","WINDOW"]},"schedule_args":{"$ref":"#/components/schemas/ScheduleArgs"},"operation_device_query":{"type":"object"},"arguments":{"type":"object","properties":{"converge_with_provision":{"type":"boolean"},"sample_key":{"type":"string"},"geofence_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of geofence UUIDs to apply (APPLY_GEO_FENCE)."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"}}}},"reason":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string","format":"uuid"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string","format":"uuid"},"operation_activity":{"$ref":"#/components/schemas/OperationActivity"},"operation_stats":{"$ref":"#/components/schemas/OperationStats"}}}},"components/schemas/Operations_POST":{"id":"components/schemas/Operations_POST","kind":"json-schema","title":"Operations_POST","data":{"type":"object","properties":{"operation_type":{"type":"string","description":"","enum":["CONVERGE","INSTALL","UNINSTALL","INSTALL_APP","UNINSTALL_APP","REBOOT","LOCK","SHUT_DOWN","WIPE","ADD_EMM_ACCOUNT","ADD_OVERRIDE_APN","ADD_WIFI_AP","REMOVE_WIFI_AP","SET_ETHERNET_SETTINGS","SET_STATIC_IP","USE_ONLY_SAVED_WIFI_AP","ADD_TO_WHITELIST","REMOVE_FROM_WHITELIST","ALLOW_BLUETOOTH","ALLOW_CAMERA","ALLOW_FACTORY_RESET","ALLOW_UNENROLLMENT_FROM_DEVICE","DEFER_OS_UPDATES","PAUSE_OS_UPDATES","SET_OS_UPDATE_POLICY","APPLE_APP_UNINSTALL","APPLY_APP_CONFIG","CLEAR_APP_DATA","DIRECT_IOS_APP_INSTALL","INSTALL_CERTIFICATE","INSTALL_OTA","NOTIFY_OTA","REFRESH_APPLIST","SET_APP_NOTIFICATIONS","SET_APP_PERMISSION","SET_APP_STATE","SET_KIOSK_APP","SET_MULTI_APP_MODE","SET_NEW_POLICY","SIMPLE_INSTALL","SYNC_CONTENT","UNINSTALL_CERTIFICATE","VPP_APP_INSTALL","INSTALL_PROFILE","INSTALL_PROVISIONING_PROFILE","INSTALL_WEBCLIP","REMOVE_PROVISIONING_PROFILE","UNINSTALL_WEBCLIP","LIST_PROVISIONING_PROFILES","BEEP_DEVICE","CAPTURE_SCREENSHOT","INITIATE_CONFERENCE_CALL","INITIATE_OFFER","NOTIFY_DEVICE","NUDGE_DEVICE","REQUEST_BUGREPORT","REQUEST_DPCLOG","DEPLOY_SYSTEM_OTA","UPDATE_BLUEPRINT","UPDATE_DEVICE_CONFIG","UPDATE_OEM_CONFIG","CLEAR_PASSCODE","RESET_LOCKSCREEN_PASSWORD","SET_ADB_STATE","SET_DEVICE_LOCKDOWN_STATE","DISABLE_LOST_MODE","ENABLE_LOST_MODE","LOST_MODE_DEVICE_LOCATION","PLAY_LOST_MODE_SOUND","SET_BLUETOOTH_STATE","SET_BRIGHTNESS_SCALE","SET_DEVICE_LANGUAGE","SET_GEO_FENCE","SET_GPS_STATE","SET_LOCATION_SERVICE","SET_ROTATION_STATE","SET_SCREEN_OFF_TIMEOUT","SET_STREAM_VOLUME","SET_TIMEZONE","SET_WALLPAPER","SET_WIDGET","SET_WIFI_STATE","RUN_CSP_PAYLOAD","SET_PFN","COLLECT_LOGS","REMOTE_CONNECTION","REMOVE_AGENT","REMOVE_DEVICE","RUN_CUSTOM_ACTION","RUN_SHELL_SCRIPT","DECLARATIVE_MANAGEMENT","APPLY_GEO_FENCE"]},"schedule_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule types are supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n"},"children":[]}]}],"enum":["IMMEDIATE","WINDOW"]},"schedule_args":{"$ref":"#/components/schemas/ScheduleArgs"},"operation_device_query":{"type":"object","description":"A flexible JSON object to define device properties and filters.","properties":{}},"arguments":{"type":"object","properties":{"converge_with_provision":{"type":"boolean"},"sample_key":{"type":"string"},"geofence_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of geofence UUIDs to apply (APPLY_GEO_FENCE)."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"}}}}}}},"components/schemas/DeviceOperationActivity":{"id":"components/schemas/DeviceOperationActivity","kind":"json-schema","title":"DeviceOperationActivity","data":{"type":"object","properties":{"device_operation_state":{"type":"string","description":"The state of the device operation (e.g., queued, processing).","example":"CREATED"},"created_at":{"type":"string","format":"date-time","description":"The start time of the device operation state."}}}},"components/schemas/DeviceOperationWithStats":{"id":"components/schemas/DeviceOperationWithStats","kind":"json-schema","title":"DeviceOperationWithStats","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"operation_id":{"type":"string","format":"uuid"},"device_id":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["CREATED","INITIATED","SUCCEDED","FAILED"]},"reason":{"type":"string","example":""},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"device_operation_activity":{"type":"array","items":{"$ref":"#/components/schemas/DeviceOperationActivity"}}}}},"components/schemas/RemoteViewerSessionsListForTenantResponse":{"id":"components/schemas/RemoteViewerSessionsListForTenantResponse","kind":"json-schema","title":"RemoteViewerSessionsListForTenantResponse","data":{"type":"object","properties":{"session_id":{"type":"string","format":"uuid"},"device_id":{"type":"string","format":"uuid"},"state":{"type":"string","enum":["INITIATED","ACKNOWLEDGED","ACTIVE","TERMINATED","FAILED"]},"reason":{"type":"string"},"video_quality":{"type":"string","enum":["STANDARD","DATA_SAVER"]},"duration":{"type":"string","format":"duration","description":"Depicts the time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).","example":"PT10M30S"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"device_name":{"type":"string","description":"Name of the device."},"device_alias":{"type":"string","description":"Alias of the device (if any)."},"device_state":{"$ref":"#/components/schemas/DeviceStateEnumAndroid"}}}},"components/schemas/VPPLicense":{"id":"components/schemas/VPPLicense","kind":"json-schema","title":"VPPLicense","data":{"type":"object","properties":{"app_id":{"type":"string"},"assigned_count":{"type":"integer"},"available_count":{"type":"integer"},"pricing_param":{"type":"string"},"supported_platforms":{"type":"array","items":{"type":"string"}},"total_count":{"type":"integer"}}}},"components/schemas/ItunesAppInfoV2":{"id":"components/schemas/ItunesAppInfoV2","kind":"json-schema","title":"ItunesAppInfoV2","data":{"type":"object","properties":{"app_id":{"type":"string","format":"uuid","description":"App ID in UUID format"},"apple_app_id":{"type":"string","description":"App ID from Apple"},"app_version_id":{"type":"string","format":"uuid","description":"current version of the app in UUID format"},"apple_app_version":{"type":"string","description":"current version of the app"},"app_name":{"type":"string","description":"name of the app"},"icon_url":{"type":"string","description":"url of the app's icon"},"developer":{"type":"string","description":"developer of the app"},"itunes_url":{"type":"string","description":"URL for the app on the iTunes store"},"genres":{"type":"array","items":{"type":"string","description":"genre of the app"}},"device_families":{"type":"array","items":{"type":"string","description":"devices the app is compatible with"}},"bundle_id":{"type":"string","description":"bundle ID of the app"},"price":{"type":"number","description":"price of the app"},"app_size":{"type":"integer","description":"size of the app"},"minimum_os_version":{"type":"string","description":"minimum OS version required for the app"},"description":{"type":"string","description":"description of the app"},"last_updated_date":{"type":"string","description":"date the app was last updated"},"pricing_param":{"type":"string","description":"pricing parameter"}}}},"components/schemas/SetPreferredRegionRequest":{"id":"components/schemas/SetPreferredRegionRequest","kind":"json-schema","title":"SetPreferredRegionRequest","data":{"type":"object","required":["preferred_region"],"properties":{"preferred_region":{"type":"string","pattern":"^[a-zA-Z]{2}$","description":"ISO 3166-1 alpha-2 country code for the preferred App Store region (e.g., 'US', 'JP')","example":"US"}}}},"components/schemas/TenantAppResponse":{"id":"components/schemas/TenantAppResponse","kind":"json-schema","title":"TenantAppResponse","data":{"type":"object","properties":{"id":{"type":"string"},"platform":{"type":"string","enum":["APPLE","WINDOWS"]},"tenant_id":{"type":"string"},"package_name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"components/schemas/AppUploadRequestBody":{"id":"components/schemas/AppUploadRequestBody","kind":"json-schema","title":"AppUploadRequestBody","data":{"type":"object","properties":{"platform":{"type":"string","enum":["APPLE","WINDOWS"]},"file":{"type":"string","format":"binary"}}}},"components/schemas/TenantAppUploadResponse":{"id":"components/schemas/TenantAppUploadResponse","kind":"json-schema","title":"TenantAppUploadResponse","data":{"type":"object","properties":{"id":{"type":"string"},"version_id":{"type":"string"},"app_name":{"type":"string"},"platform":{"type":"string","enum":["APPLE","WINDOWS"]},"tenant_id":{"type":"string"},"package_name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string"}}}},"components/schemas/Error_403_Forbidden":{"id":"components/schemas/Error_403_Forbidden","kind":"json-schema","title":"Error_403_Forbidden","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","default":403},"message":{"type":"string"},"content":{"type":"object"}},"required":["code","message"]}},"components/schemas/TenantAppVersionResponse":{"id":"components/schemas/TenantAppVersionResponse","kind":"json-schema","title":"TenantAppVersionResponse","data":{"type":"object","properties":{"id":{"type":"string"},"app_id":{"type":"string"},"app_type":{"type":"string","enum":["TENANT_IOS","TENANT_WINDOWS"]},"tenant_id":{"type":"string"},"app_name":{"type":"string"},"app_icon_url":{"type":"string"},"release_notes":{"type":"string"},"description":{"type":"string"},"file_size_in_kb":{"type":"integer"},"device_family":{"type":"array","items":{"type":"string"}},"version_name":{"type":"string"},"build_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build number of the app. Omitted when legacy_format is false."},"children":[]}]}]}]},"version_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version code of the app (same as build_number). Only present when legacy_format is false."},"children":[]}]}]}]},"min_sdk_version":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"updated_by":{"type":"string"}}}},"components/schemas/TenantAppVersionDetailResponse":{"id":"components/schemas/TenantAppVersionDetailResponse","kind":"json-schema","title":"TenantAppVersionDetailResponse","data":{"allOf":[{"$ref":"#/components/schemas/TenantAppVersionResponse"},{"type":"object","properties":{"app_download_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Presigned URL for downloading the app binary. Present for TENANT_IOS (IPA) and TENANT_WINDOWS (MSI) app types."},"children":[]}]}]}]},"app_sha256_hash":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SHA256 hash of the app binary. Present for TENANT_IOS and TENANT_WINDOWS app types."},"children":[]}]}]}]},"product_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MSI product code. Present only when app_type is TENANT_WINDOWS."},"children":[]}]}]}]}}}]}},"components/schemas/AppleAppStoreApp":{"id":"components/schemas/AppleAppStoreApp","kind":"json-schema","title":"AppleAppStoreApp","data":{"type":"object","properties":{"icon":{"type":"string","format":"uri","description":"URL for the app icon","example":"https://icon-url.com"},"name":{"type":"string","description":"Name of the app","example":"Safari"},"bundle_id":{"type":"string","description":"Bundle identifier for the app","example":"com.apple.mobilesafari"},"file_size_in_bytes":{"type":"string","description":"File size of the app in bytes","example":"100"},"app_store_url":{"type":"string","format":"uri","description":"URL to the app store listing","example":"https://apps.apple.com/us/app/"},"minimum_os":{"type":"string","description":"Minimum OS version required","example":"10.0"},"release_date":{"type":"string","format":"date-time","description":"Release date of the app","example":"2021-10-25T07:00:00Z"},"seller_name":{"type":"string","description":"Name of the seller","example":"Apple Inc."}}}},"components/schemas/AppInfo":{"id":"components/schemas/AppInfo","kind":"json-schema","title":"AppInfo","data":{"type":"object","properties":{"app_id":{"type":"string","description":"Unique identifier for the app."},"app_version_id":{"type":"string","description":"Unique identifier for the app version."},"app_type":{"type":"string","description":"Type of the app."},"tenant_id":{"type":"string","description":"Identifier for the tenant."},"name":{"type":"string","description":"Name of the app to show on console."},"label":{"type":"string","description":"Label for the app to show on device."},"icon_url":{"type":"string","format":"uri","description":"URL to the app icon."},"package_name":{"type":"string","description":"Unique identifier for the app bundle."},"is_removable":{"type":"boolean","description":"Indicates if the app can be removed."},"is_full_screen":{"type":"boolean","description":"Indicates if the app runs in full-screen mode."},"url":{"type":"string","format":"uri","description":"URL to access the app."},"file_size_in_kb":{"type":"integer","description":"Size of the app in kilobytes."},"release_notes":{"type":"string","description":"Release notes for the app version."},"description":{"type":"string","description":"Description of the app."},"build_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build number of the app. Omitted when legacy_format is false."},"children":[]}]}]}]},"version_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version code of the app (same as build_number). Only present when legacy_format is false."},"children":[]}]}]}]},"version_name":{"type":"string","description":"Version name of the app."},"min_sdk_version":{"type":"string","description":"Minimum SDK version required to run the app."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the app was created."},"created_by":{"type":"string","description":"User who created the app entry."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the app was last updated."},"updated_by":{"type":"string","description":"User who last updated the app entry."}}}},"components/schemas/Webclip":{"id":"components/schemas/Webclip","kind":"json-schema","title":"Webclip","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the web clip","example":"09811f63-e2ca-4625-97c1-081145195d67"},"tenant_id":{"type":"string","format":"uuid","description":"Tenant identifier","example":"7d5fd1bf-bdf9-490b-9e32-203756a61235"},"label":{"type":"string","description":"Label of the web clip","example":"Google"},"url":{"type":"string","format":"uri","description":"URL associated with the web clip","example":"https://www.google.com/"},"icon_url":{"type":"string","format":"uri","nullable":true,"description":"URL for the icon of the web clip","example":null},"target_bundle_name":{"type":"string","description":"Name of the target bundle","example":"Esper"},"target_bundle_id":{"type":"string","description":"ID of the target bundle","example":"com.esper.io"},"is_full_screen":{"type":"boolean","description":"Indicates if the web clip is full screen","example":false},"is_removable":{"type":"boolean","description":"Indicates if the web clip is removable","example":true},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the web clip was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the web clip was last updated"},"created_by":{"type":"string","description":"The user who created the web clip"},"updated_by":{"type":"string","description":"The user who last updated the web clip"}}}},"components/schemas/WebclipCreateRequest":{"id":"components/schemas/WebclipCreateRequest","kind":"json-schema","title":"WebclipCreateRequest","data":{"type":"object","properties":{"icon":{"type":"string","format":"binary","description":"Icon of the webclip"},"label":{"type":"string","description":"Label of the web clip which is displayed on device","example":"Example Label"},"esper_name":{"type":"string","description":"Name of the webclip in Esper","example":"Example Name"},"url":{"type":"string","description":"URL for the webclip","example":"https://example.com"},"target_bundle_id":{"type":"string","description":"Target bundle ID for the webclip","example":"com.example.bundle"},"target_bundle_name":{"type":"string","description":"Target bundle name for the webclip","example":"Example Bundle"},"is_full_screen":{"type":"boolean","description":"Indicates if the webclip is full screen","example":true},"is_removable":{"type":"boolean","description":"Indicates if the webclip is removable","example":false}},"required":["label","esper_name","url","target_bundle_id","target_bundle_name","is_full_screen","is_removable"]}},"components/schemas/ProvisioningProfileUploadResponse":{"id":"components/schemas/ProvisioningProfileUploadResponse","kind":"json-schema","title":"ProvisioningProfileUploadResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the provisioning profile"},"version_id":{"type":"string","format":"uuid","description":"Unique identifier for this specific version of the profile"},"name":{"type":"string","description":"Display name of the provisioning profile"},"team_identifier":{"type":"string","description":"Apple Developer Team identifier"},"app_identifier":{"type":"string","description":"Bundle identifier of the associated app"},"profile_type":{"type":"string","description":"Type of profile (development, distribution, etc.)","enum":["development","ad-hoc","app-store","enterprise"]},"expiration_date":{"type":"string","format":"date-time","description":"When the provisioning profile expires"},"tenant_id":{"type":"string","format":"uuid","description":"Tenant that owns this provisioning profile"},"created_at":{"type":"string","format":"date-time","description":"When the provisioning profile was first created"},"updated_at":{"type":"string","format":"date-time","description":"When this version was last updated"},"created_by":{"type":"string","description":"User who created the provisioning profile"},"updated_by":{"type":"string","description":"User who created this version"}}}},"components/schemas/ProvisioningProfileWithDownloadResponse":{"id":"components/schemas/ProvisioningProfileWithDownloadResponse","kind":"json-schema","title":"ProvisioningProfileWithDownloadResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/ProvisioningProfileUploadResponse"},{"type":"object","properties":{"download_url":{"type":"string","format":"uri","description":"Signed URL for downloading the provisioning profile file","example":"https://s3.amazonaws.com/bucket/provisioning-profiles/profile.mobileprovision?signature=abc123"}}}]}},"components/schemas/ProvisioningProfileUploadRequest":{"id":"components/schemas/ProvisioningProfileUploadRequest","kind":"json-schema","title":"ProvisioningProfileUploadRequest","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Provisioning profile file (.mobileprovision)"}},"required":["file"]}},"components/schemas/ProvisioningProfileVersionWithDownloadResponse":{"id":"components/schemas/ProvisioningProfileVersionWithDownloadResponse","kind":"json-schema","title":"ProvisioningProfileVersionWithDownloadResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Primary key and unique identifier for this version"},"profile_id":{"type":"string","format":"uuid","description":"Foreign key reference to the parent ProvisioningProfile"},"uuid":{"type":"string","description":"Apple's UUID for this specific provisioning profile version"},"name":{"type":"string","description":"Display name of the provisioning profile version"},"sha256_hash":{"type":"string","description":"SHA256 hash of the provisioning profile file for duplicate detection"},"creation_date":{"type":"string","format":"date-time","description":"When Apple created this provisioning profile (from .mobileprovision file)"},"expiration_date":{"type":"string","format":"date-time","description":"When this provisioning profile expires (from Apple)"},"time_to_live":{"type":"integer","description":"Days until expiration from creation date"},"provisions_all_devices":{"type":"boolean","description":"Whether this profile provisions all devices (enterprise profiles)"},"is_xcode_managed":{"type":"boolean","description":"Whether this profile is managed by Xcode automatically"},"platforms":{"type":"string","description":"JSON array of supported platforms (iOS, macOS, etc.)"},"entitlements":{"type":"string","description":"JSON object of app entitlements and capabilities"},"developer_certificates":{"type":"string","description":"JSON array of developer certificates included in this profile"},"tenant_id":{"type":"string","format":"uuid","description":"Tenant that owns this provisioning profile version"},"created_by":{"type":"string","description":"User identifier who uploaded this version"},"updated_by":{"type":"string","description":"User identifier who last modified this version record"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when this version record was created in the database"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when this version record was last modified"},"download_url":{"type":"string","format":"uri","description":"Signed URL for downloading the provisioning profile file","example":"https://s3.amazonaws.com/bucket/provisioning-profiles/version.mobileprovision?signature=abc123"}}}},"components/schemas/TenantPreferredRegions":{"id":"components/schemas/TenantPreferredRegions","kind":"json-schema","title":"TenantPreferredRegions","data":{"type":"object","properties":{"tenant_id":{"type":"string","format":"uuid","description":"Unique identifier for the tenant"},"countries":{"type":"array","items":{"type":"string"},"description":"List of preferred country codes","example":["AU","IN","US"]},"created_by":{"type":"string","description":"The user who created the preferred regions"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the preferred regions were first created"},"updated_by":{"type":"string","description":"The user who last updated the preferred regions"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the preferred regions were last updated"}}}},"components/schemas/SetPreferredRegionsRequest":{"id":"components/schemas/SetPreferredRegionsRequest","kind":"json-schema","title":"SetPreferredRegionsRequest","data":{"type":"object","required":["countries"],"properties":{"countries":{"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}$"},"description":"List of ISO 3166-1 alpha-2 country codes (2-character uppercase). An empty array clears the tenant's preferred region preference.","example":["AU","IN","US"]}}}},"components/schemas/EsperAppVersionResponse":{"id":"components/schemas/EsperAppVersionResponse","kind":"json-schema","title":"EsperAppVersionResponse","data":{"type":"object","properties":{"id":{"type":"string"},"app_id":{"type":"string"},"app_type":{"type":"string","enum":["TENANT_IOS","ESPER_IOS","ESPER_ANDROID","ESPER_LINUX","ESPER_WINDOWS"]},"app_name":{"type":"string"},"app_icon_url":{"type":"string"},"app_download_url":{"type":"string"},"app_sha256_hash":{"type":"string"},"signature_hash":{"type":"string","description":"SHA-256 fingerprint of the app's public key in uppercase hexadecimal with colon separators (only for Android apps)"},"architecture":{"type":"string"},"release_notes":{"type":"string"},"description":{"type":"string"},"file_size_in_kb":{"type":"integer"},"device_family":{"type":"array","items":{"type":"string"}},"version_name":{"type":"string"},"build_number":{"type":"string"},"min_sdk_version":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"updated_by":{"type":"string"}}}},"components/schemas/TenantEsperAppsItem":{"id":"components/schemas/TenantEsperAppsItem","kind":"json-schema","title":"TenantEsperAppsItem","data":{"type":"object","properties":{"tenant_id":{"type":"string"},"app_version_id":{"type":"string"},"app_id":{"type":"string"},"package_name":{"type":"string","description":"Package name of the app (only shown for Android apps)"},"app_sha256_hash":{"type":"string"},"signature_hash":{"type":"string","description":"Signature hash of the app (only shown for Android apps)"},"architecture":{"type":"string"},"app_download_url":{"type":"string"},"version_code":{"type":"string","description":"Version code of the app (only shown for Android apps)"},"created_by":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}}},"components/schemas/DeviceCommandEnum":{"id":"components/schemas/DeviceCommandEnum","kind":"json-schema","title":"DeviceCommandEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following commands are supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* ADD_TO_WHITELIST: Whitelist an installed sytem app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* ADD_WIFI_AP : Add wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* APPLY_APP_CONFIG : Apply app configuration for an installed app.\n* CLEAR_APP_DATA : Clear data for an installed app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* CONVERGE: Converge command for Blueprint\n* INSTALL: Install an app on a device. Requires `app_version` in command arguments where `app_version` is the version id of app uploaded on Esper\n* INSTALL_CERTIFICATE: Install a certificate chain in the system keystore of an android device. Requires `cert_file_type`, `cert_data_base64`, `cert_alias_name` and `cert_storage_type` in command arguments where `cert_file_type` must be set to \"pkcs12\", `cert_data_base64` contains the base64 encoded content of the pkcs12 file, `cert_alias_name` is the alias name with which the certificate chain is supposed to be installed and `cert_storage_type` must be set to \"system\". If the pkcs12 file is password protected, the password should be specified in the optional parameter `cert_password`.\n* LOCK: Lock device screen, Supports Android, iOS and Windows devices.\n* REBOOT: Reboot a device. Supports Android, iOS, and Windows devices.\n* REMOVE_FROM_WHITELIST : Remove an installed system app from whitelist. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* REMOVE_WIFI_AP : Remove Wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* SET_APP_PERMISSION : Set permission for an installed app. Requires `package_name`, `grant_state`, `permission` in command arguments where `package_name` is the app package uploaded on Esper, `grant_state` should be \"PERMISSION_GRANT_STATE_DEFAULT\", \"PERMISSION_GRANT_STATE_DENIED\", \"PERMISSION_GRANT_STATE_GRANTED\" and `permission` is a valid permission\n* SET_APP_STATE : Set the state of an app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN. Requries `app_state` and `package_name` in command arguments where `app_state` is the state of app and `package_name` is the app package uploaded on Esper For LAUNCHABLE_BUT_HIDDEN: Hide an app on the home screen but allow it to be launched from other apps. Requires Esper agent 8.5+ and `package_name`. \n* SET_BLUETOOTH_STATE : Set bluetooth state (ON/OFF) for device. Requires `bluetooth_state` in command arguments where `bluetooth_state` is a boolean.\n* SET_BRIGHTNESS_SCALE : Set brightness for device. Requires `brightness_value` in command arguments where `brightness_value` is an integer (1-100).\n* SET_DEVICE_LOCKDOWN_STATE : Set lockdown state for a device. Requires `state` and `message` in command arguments where `state` is LOCKED/UNLOCKED and `message` is the message to be added with command\n* SET_GPS_STATE :Set the GPS state for a device. Requires `gps_state` in command arguments where `gps_state` should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)\n* SET_KIOSK_APP : Command to set the Kiosk app for a device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n\n* SET_MULTI_APP_MODE : Command to set the device back to multi app mode.\n* SET_NEW_POLICY : Apply policy on device. Requires `policy_url` in command arguments where `policy_url` is the URL to the policy\n* SET_ROTATION_STATE : Set screen orientation. Requires `rotate_state` in command arguments where `rotate_state` should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)\n* SET_SCREEN_OFF_TIMEOUT: Set screen off timeout for a device. Requires `screen_off_timeout` in command arguments where `screen_off_timeout` should be either -1 or between 5000 and 1800000\n* SET_STREAM_VOLUME : Set strema volume for a device. Requires `stream` and `volume_level` in command arguments where `stream` should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music) and `volume_level` should be a value from 0 to 100\n* SET_TIMEZONE : Set the timezone for a device. Requires `timezone_string` in command arguments where `timezone_string` is a valid string representing the timezone\n* SET_WIFI_STATE : Set the wifi state (ON/OFF) for a device. Requires `wifi_state` in command arguments where `wifi_state` is a boolean.\n* UNINSTALL: Uninstall an app from device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* UNINSTALL_CERTIFICATE: Uninstall a certificate from an android device's system keystore using the installed certificate's alias name. Requires `cert_alias_name` and `cert_storage_type` in command arguments where `cert_alias_name` is the alias name of the certificate to be uninstalled and `cert_storage_type` must be set to \"system\"\n* UPDATE_DEVICE_CONFIG: Push additional configurations to the Device\n* UPDATE_HEARTBEAT: Ping a device\n* UPDATE_LATEST_DPC : Prompt device to update the DPC app to the latest versions.\n* WIPE : Wipes the device.\n* RESET_LOCKSCREEN_PASSWORD: Change the lockscreen password of the device. Requires `new_lockscreen_password` in command arguments where `new_lockscreen_password` is a valid string.\n* UPDATE_BLUEPRINT: Pushes or reapplies the most current Blueprint version to the device or group.\n* NOTIFY_DEVICE: Allows you to  broadcast message to the device.\n* SET_DEVICE_LANGUAGE: Set language for a device. Requires locale value in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code.\n* SET_ETHERNET_SETTINGS: Set ethernet settings on supported Device\n* SET_STATIC_IP: Set static ip on the deivce. Requires interface, dhcp_dnabled, static_ip, primary_dns, subnet_mask, gateway, secondary_dns (optional)\n* BEEP_DEVICE: Allows you to make the device beep for a specified duration\n* SET_APP_NOTIFICATIONS: Enable/disable app notifications. Requries `app_notifications_state` and `package_name` in command arguments where `app_notifications_state` is a string that has the value `ENABLED` or `DISABLED` and `package_name` is the app package uploaded on Esper.\n* USE_ONLY_SAVED_WIFI_AP: Allow/disallow device to connect to unregistered WiFi APs. Requires boolean `use_only_saved_ap`..\n* DEVICE_INFORMATION: Prompt device to update the device information\n* VPP_APP_INSTALL: Install a vpp app on an iOS device. Requires `app_id` and `bundle_identifier` in command arguments that corresponds to the associate vpp app\n* APPLE_APP_UNINSTALL: Uninstall an app on an iOS device. Requires `app_id` and `bundle_identifier` in command arguments that corresponds to the associated app\n* CLEAR_PASSCODE: Clear the passcode in a device\n* LIST_INSTALLED_PROFILES: Returns a list of all installed profiles on an iOS device.\n* INSTALL_PROFILE: Install a profile on an iOS device.\n* REMOVE_PROFILE: Remove a profile from an iOS device.\n* RUN_SHELL_SCRIPT: Run a shell script on a Linux or Windows device. Requires `script` and `interpreter` in command arguments.\n* RUN_CUSTOM_ACTION: Run a custom action (script) on a Linux device. Requires custom action parameters in command arguments.\n* COLLECT_LOGS: Collect and upload Esper agent logs from a Linux device.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* ADD_TO_WHITELIST: Whitelist an installed sytem app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* ADD_WIFI_AP : Add wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* APPLY_APP_CONFIG : Apply app configuration for an installed app.\n* CLEAR_APP_DATA : Clear data for an installed app. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* CONVERGE: Converge command for Blueprint\n* INSTALL: Install an app on a device. Requires `app_version` in command arguments where `app_version` is the version id of app uploaded on Esper\n* INSTALL_CERTIFICATE: Install a certificate chain in the system keystore of an android device. Requires `cert_file_type`, `cert_data_base64`, `cert_alias_name` and `cert_storage_type` in command arguments where `cert_file_type` must be set to \"pkcs12\", `cert_data_base64` contains the base64 encoded content of the pkcs12 file, `cert_alias_name` is the alias name with which the certificate chain is supposed to be installed and `cert_storage_type` must be set to \"system\". If the pkcs12 file is password protected, the password should be specified in the optional parameter `cert_password`.\n* LOCK: Lock device screen, Supports Android, iOS and Windows devices.\n* REBOOT: Reboot a device. Supports Android, iOS, and Windows devices.\n* REMOVE_FROM_WHITELIST : Remove an installed system app from whitelist. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* REMOVE_WIFI_AP : Remove Wifi access points for device. Requires `wifi_access_points` in command arguments where `wifi_access_points` is the data with access points\n* SET_APP_PERMISSION : Set permission for an installed app. Requires `package_name`, `grant_state`, `permission` in command arguments where `package_name` is the app package uploaded on Esper, `grant_state` should be \"PERMISSION_GRANT_STATE_DEFAULT\", \"PERMISSION_GRANT_STATE_DENIED\", \"PERMISSION_GRANT_STATE_GRANTED\" and `permission` is a valid permission\n* SET_APP_STATE : Set the state of an app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN. Requries `app_state` and `package_name` in command arguments where `app_state` is the state of app and `package_name` is the app package uploaded on Esper For LAUNCHABLE_BUT_HIDDEN: Hide an app on the home screen but allow it to be launched from other apps. Requires Esper agent 8.5+ and `package_name`. \n* SET_BLUETOOTH_STATE : Set bluetooth state (ON/OFF) for device. Requires `bluetooth_state` in command arguments where `bluetooth_state` is a boolean.\n* SET_BRIGHTNESS_SCALE : Set brightness for device. Requires `brightness_value` in command arguments where `brightness_value` is an integer (1-100).\n* SET_DEVICE_LOCKDOWN_STATE : Set lockdown state for a device. Requires `state` and `message` in command arguments where `state` is LOCKED/UNLOCKED and `message` is the message to be added with command\n* SET_GPS_STATE :Set the GPS state for a device. Requires `gps_state` in command arguments where `gps_state` should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)\n* SET_KIOSK_APP : Command to set the Kiosk app for a device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n\n* SET_MULTI_APP_MODE : Command to set the device back to multi app mode.\n* SET_NEW_POLICY : Apply policy on device. Requires `policy_url` in command arguments where `policy_url` is the URL to the policy\n* SET_ROTATION_STATE : Set screen orientation. Requires `rotate_state` in command arguments where `rotate_state` should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)\n* SET_SCREEN_OFF_TIMEOUT: Set screen off timeout for a device. Requires `screen_off_timeout` in command arguments where `screen_off_timeout` should be either -1 or between 5000 and 1800000\n* SET_STREAM_VOLUME : Set strema volume for a device. Requires `stream` and `volume_level` in command arguments where `stream` should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music) and `volume_level` should be a value from 0 to 100\n* SET_TIMEZONE : Set the timezone for a device. Requires `timezone_string` in command arguments where `timezone_string` is a valid string representing the timezone\n* SET_WIFI_STATE : Set the wifi state (ON/OFF) for a device. Requires `wifi_state` in command arguments where `wifi_state` is a boolean.\n* UNINSTALL: Uninstall an app from device. Requires `package_name` in command arguments where `package_name` is the app package uploaded on Esper\n* UNINSTALL_CERTIFICATE: Uninstall a certificate from an android device's system keystore using the installed certificate's alias name. Requires `cert_alias_name` and `cert_storage_type` in command arguments where `cert_alias_name` is the alias name of the certificate to be uninstalled and `cert_storage_type` must be set to \"system\"\n* UPDATE_DEVICE_CONFIG: Push additional configurations to the Device\n* UPDATE_HEARTBEAT: Ping a device\n* UPDATE_LATEST_DPC : Prompt device to update the DPC app to the latest versions.\n* WIPE : Wipes the device.\n* RESET_LOCKSCREEN_PASSWORD: Change the lockscreen password of the device. Requires `new_lockscreen_password` in command arguments where `new_lockscreen_password` is a valid string.\n* UPDATE_BLUEPRINT: Pushes or reapplies the most current Blueprint version to the device or group.\n* NOTIFY_DEVICE: Allows you to  broadcast message to the device.\n* SET_DEVICE_LANGUAGE: Set language for a device. Requires locale value in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code.\n* SET_ETHERNET_SETTINGS: Set ethernet settings on supported Device\n* SET_STATIC_IP: Set static ip on the deivce. Requires interface, dhcp_dnabled, static_ip, primary_dns, subnet_mask, gateway, secondary_dns (optional)\n* BEEP_DEVICE: Allows you to make the device beep for a specified duration\n* SET_APP_NOTIFICATIONS: Enable/disable app notifications. Requries `app_notifications_state` and `package_name` in command arguments where `app_notifications_state` is a string that has the value `ENABLED` or `DISABLED` and `package_name` is the app package uploaded on Esper.\n* USE_ONLY_SAVED_WIFI_AP: Allow/disallow device to connect to unregistered WiFi APs. Requires boolean `use_only_saved_ap`..\n* DEVICE_INFORMATION: Prompt device to update the device information\n* VPP_APP_INSTALL: Install a vpp app on an iOS device. Requires `app_id` and `bundle_identifier` in command arguments that corresponds to the associate vpp app\n* APPLE_APP_UNINSTALL: Uninstall an app on an iOS device. Requires `app_id` and `bundle_identifier` in command arguments that corresponds to the associated app\n* CLEAR_PASSCODE: Clear the passcode in a device\n* LIST_INSTALLED_PROFILES: Returns a list of all installed profiles on an iOS device.\n* INSTALL_PROFILE: Install a profile on an iOS device.\n* REMOVE_PROFILE: Remove a profile from an iOS device.\n* RUN_SHELL_SCRIPT: Run a shell script on a Linux or Windows device. Requires `script` and `interpreter` in command arguments.\n* RUN_CUSTOM_ACTION: Run a custom action (script) on a Linux device. Requires custom action parameters in command arguments.\n* COLLECT_LOGS: Collect and upload Esper agent logs from a Linux device.\n"},"children":[]}]}],"enum":["ADD_TO_WHITELIST","ADD_WIFI_AP","APPLY_APP_CONFIG","CLEAR_APP_DATA","CONVERGE","INSTALL","INSTALL_CERTIFICATE","LIST_INSTALLED_PROFILES","LOCK","REBOOT","REMOVE_FROM_WHITELIST","REMOVE_PROFILE","REMOVE_WIFI_AP","SET_APP_PERMISSION","SET_APP_STATE","SET_BLUETOOTH_STATE","SET_BRIGHTNESS_SCALE","SET_DEVICE_LOCKDOWN_STATE","SET_GPS_STATE","SET_KIOSK_APP","SET_MULTI_APP_MODE","SET_NEW_POLICY","SET_ROTATION_STATE","SET_SCREEN_OFF_TIMEOUT","SET_STREAM_VOLUME","SET_TIMEZONE","SET_WIFI_STATE","UNINSTALL","UNINSTALL_CERTIFICATE","UPDATE_DEVICE_CONFIG","UPDATE_HEARTBEAT","UPDATE_LATEST_DPC","WIPE","RESET_LOCKSCREEN_PASSWORD","UPDATE_BLUEPRINT","NOTIFY_DEVICE","SET_DEVICE_LANGUAGE","SET_ETHERNET_SETTINGS","SET_STATIC_IP","BEEP_DEVICE","SET_APP_NOTIFICATIONS","USE_ONLY_SAVED_WIFI_AP","DEVICE_INFORMATION","VPP_APP_INSTALL","APPLE_APP_UNINSTALL","CLEAR_PASSCODE","INSTALL_PROFILE","RUN_SHELL_SCRIPT","RUN_CUSTOM_ACTION","COLLECT_LOGS"]}},"components/schemas/CommandArgs":{"id":"components/schemas/CommandArgs","kind":"json-schema","title":"Command args","data":{"title":"Command args","type":"object","properties":{"device_alias_name":{"type":"string","description":"Alternate human-readable name for your Device"},"custom_settings_config":{"type":"object","properties":{},"description":"Managed configurations for your device (passed as JSON object)"},"app_version":{"type":"string","description":"The version id of app uploaded on Esper"},"package_name":{"type":"string","description":"The app package name uploaded on Esper"},"policy_url":{"type":"string","description":"The URL to the policy"},"wifi_access_points":{"type":"object","properties":{},"description":"Wifi access points for the device (passed as JSON object)"},"state":{"type":"string","description":"LOCKED/UNLOCKED"},"message":{"type":"string","description":"Message to be added with command to notify device."},"title":{"type":"string","description":"Message title  to be added with command to notify device."},"url":{"type":"string","description":"(Optional) Link to notify device."},"app_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of app - SHOW/HIDE/DISABLE/LAUNCHABLE_BUT_HIDDEN"},"children":[]}]}]}]},"bluetooth_state":{"type":"boolean","description":"The state of bluetooth - ON/OFF"},"brightness_value":{"type":"integer","description":"The brightness value of a device(1-100)"},"gps_state":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The GPS state of a device. Should be either 0, 1, 2, 3 or 4 (LOCATION_MODE_HIGH_ACCURACY = 0, LOCATION_MODE_SENSORS_ONLY = 1, LOCATION_MODE_BATTERY_SAVING = 2, LOCATION_MODE_OFF = 3, LOCATION_MODE_ON = 4)"},"children":[]}]}]}]},"rotate_state":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The screen orientation of a device. Should be either 0, 1 or 2 (0 = AUTO, 1 = PORTRAIT_ONLY, 2 = LANDSCAPE_ONLY)"},"children":[]}]}]}]},"screen_off_timeout":{"type":"integer","description":"The value for screen timeout of a device. Should be either -1 or between 5000 and 1800000"},"stream":{"type":"integer","description":"The value of the volume stream. Should be either 0(Ring), 1(Notification), 2(Alarm) or 3(Music)"},"volume_level":{"type":"integer","description":"The level of volume. Should be a value from 0 to 100"},"timezone_string":{"type":"integer","description":"The timezone of a device. Should be a valid timezone string"},"wifi_state":{"type":"boolean","description":"The state of WIFI - ON/OFF"},"wifi_revert_timeout":{"type":"integer","description":"The WIFI revert timeout. Should be greater than or equal to 1"},"locale":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Language and country code in xx[_Zzzz]_yy where xx is language code, Zzzz is script (optional) and yy is country code."},"children":[]}]}]}]},"ethernet_auth_mode":{"type":"string","description":"Chosen mode of authentication","enum":["NONE","EAP_TLS"]},"ethernet_ca_cert_alias":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CA certificate alias. It is mandatory with Auth Mode EAP_TLS"},"children":[]}]}]}]},"ethernet_client_cert_alias":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client certificate alias. It is mandatory with Auth Mode EAP_TLS"},"children":[]}]}]}]},"ethernet_eap_identity":{"type":"string","description":"EAP identity"},"interface":{"type":"string","description":"The network interface of the device - wlan/eth"},"dhcp_enabled":{"type":"string","description":"The dhcp state on the device - true/false"},"static_ip":{"type":"string","description":"The static ip to set on the device. Should be a valid ipv4"},"primary_dns":{"type":"string","description":"The primary dns to set on the device. Should be a valid ipv4"},"subnet_mask":{"type":"string","description":"The subnet mask set on the device. Should between 1-32 both inclusive"},"secondary_dns":{"type":"string","description":"The secondary dns to set on the device. Should be a valid ipv4"},"gateway":{"type":"string","description":"The gateway to set on the device. Should be a valid ipv4"},"duration":{"type":"string","description":"The beep duration specified in seconds. Value must be between 10 and 300, both inclusive."},"video_quality":{"type":"string","default":"HIGH","description":"The video quality of the respective Remote Viewer session. Options are \"LOW\", \"MEDIUM\" and \"HIGH\"."},"enable_debug_mode":{"type":"boolean","default":false,"description":"The flag to determine whether device must go into Debug Mode, in order to retreive bug report when the device is already in Kiosk Mode."},"app_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for VPP application in Apple’s ecosystem"},"children":[]}]}]}]},"bundle_identifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for an application in Apple’s ecosystem"},"children":[]}]}]}]},"managed_only":{"type":"boolean","description":"If true, list outs only the profiles that was installed via MDM."},"profile_identifier":{"type":"string","description":"The identifier of the profile to remove."},"profile":{"type":"string","description":"Base 64 encoded profile plist to be installed on the device."},"is_converge":{"type":"boolean","description":"This value indicates that the command belongs to a converge action."},"script":{"type":"string","description":"A complete shell script to execute on Linux or Windows devices."},"interpreter":{"type":"string","description":"Type of interpreter to use for executing the script. e.g. For Linux use bash, zsh, or sh. For Windows use powershell. This field is mandatory."},"execute_as":{"type":"string","description":"User to execute the script as root or Esper (default user) - Optional, default is Esper if not specified. Supports Linux devices."},"cert_file_type":{"type":"string","description":"Certificate file type. Currently file type of \"pkcs12\" is supported"},"cert_data_base64":{"type":"string","description":"Base64 encoded content of the certificate file"},"cert_alias_name":{"type":"string","description":"Alias name of the certificate to be used during installation or uninstallation"},"cert_storage_type":{"type":"string","description":"Refers to the keystore type to be used for certificate installation or uninstallation. Currently storage type of \"system\" is supported"},"cert_password":{"type":"string","description":"Provides the password if the pkcs12 file is password protected - Optional"},"is_factory_reset":{"type":"boolean","description":"If true, performs factory reset and unenrolls the device. If false, only unenrolls the device without wiping data. Required for WIPE command on Windows devices."}}}},"components/schemas/CommandScheduleEnum":{"id":"components/schemas/CommandScheduleEnum","kind":"json-schema","title":"CommandScheduleEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule types are supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n* RECURRING: Schedule the command to execute during the scheduled time until it succeeds or expires. After executing successfully, it will not fire again.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* IMMEDIATE: Schedule the command to execcute Immediately\n* WINDOW: Schedule the command to execute within the given window\n* RECURRING: Schedule the command to execute during the scheduled time until it succeeds or expires. After executing successfully, it will not fire again.\n"},"children":[]}]}],"enum":["IMMEDIATE","WINDOW","RECURRING"]}},"components/schemas/CommandScheduleArgsTimeTypeEnum":{"id":"components/schemas/CommandScheduleArgsTimeTypeEnum","kind":"json-schema","title":"CommandScheduleArgsTimeTypeEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Time-Type argument, in Schedule args, is to indicate which timezone the Command Framework should utilize when scheduling the command."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule Args for Time-Type are supported:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* CONSOLE: Use the local timezone of the user creating the schedule.\n* DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* CONSOLE: Use the local timezone of the user creating the schedule.\n* DEVICE: Use the local timezone of the device, to which the command is issued, wherever it may be.\n"},"children":[]}]}],"enum":["console","device"]}},"components/schemas/CommandScheduleArgs":{"id":"components/schemas/CommandScheduleArgs","kind":"json-schema","title":"Command Schedule Arguments","data":{"title":"Command Schedule Arguments","type":"object","properties":{"name":{"type":"string"},"start_datetime":{"type":"string","format":"date-time"},"end_datetime":{"type":"string","format":"date-time"},"time_type":{"$ref":"#/components/schemas/CommandScheduleArgsTimeTypeEnum"},"window_start_time":{"type":"string"},"window_end_time":{"type":"string"},"days":{"type":"array","items":{"type":"string"}}}}},"components/schemas/CommandRequest":{"id":"components/schemas/CommandRequest","kind":"json-schema","title":"CommandRequest","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique command request identifier","format":"uuid","readOnly":true},"command_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of command"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* DEVICE: command request is meant for devices\n* GROUP: command request is meant for groups\n* DYNAMIC: command request is meant for dynamic set of devices\n  i.e subset of devices from different groups or otherwise.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* DEVICE: command request is meant for devices\n* GROUP: command request is meant for groups\n* DYNAMIC: command request is meant for dynamic set of devices\n  i.e subset of devices from different groups or otherwise.\n"},"children":[]}]}],"enum":["DEVICE","GROUP","DYNAMIC"]},"devices":{"maxItems":1000,"minItems":0,"type":"array","description":"list of devices to run commands","items":{"type":"string","format":"uuid"}},"groups":{"maxItems":500,"minItems":0,"type":"array","description":"list of groups to run commands","items":{"type":"string","format":"uuid"}},"device_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering by device_type is not supported currently and applies to 'all' devices. If 'active' or 'inactive' is specified, it will be ignored."},"children":[]}]}]}],"default":"active","enum":["active","inactive","all"]},"command":{"$ref":"#/components/schemas/DeviceCommandEnum"},"command_args":{"$ref":"#/components/schemas/CommandArgs"},"schedule":{"$ref":"#/components/schemas/CommandScheduleEnum"},"schedule_args":{"$ref":"#/components/schemas/CommandScheduleArgs"},"reason":{"type":"string","description":"details briefing the reason for current command request processing stage"},"created_by":{"type":"string","description":"user id of the user","readOnly":true},"created_at":{"type":"string","description":"Timestamp of command request","format":"date-time","readOnly":true}}}},"components/schemas/CommandRequest_POST":{"id":"components/schemas/CommandRequest_POST","kind":"json-schema","title":"CommandRequest_POST","data":{"type":"object","properties":{"command_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the type of command"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* DEVICE: command request is meant for devices\n* GROUP: command request is meant for groups\n* DYNAMIC: command request is meant for dynamic set of devices\n  i.e subset of devices from different groups or otherwise.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* DEVICE: command request is meant for devices\n* GROUP: command request is meant for groups\n* DYNAMIC: command request is meant for dynamic set of devices\n  i.e subset of devices from different groups or otherwise.\n"},"children":[]}]}],"enum":["DEVICE","GROUP","DYNAMIC"]},"alias":{"type":"string","description":"Another name for the command, provided by the user or Console."},"devices":{"maxItems":1000,"minItems":0,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of devices to run commands. Required if command_type is 'DEVICE' or 'DYNAMIC'"},"children":[]}]}]}],"items":{"type":"string","format":"uuid"}},"groups":{"maxItems":500,"minItems":0,"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of groups to run commands. Required if command_type is 'GROUP' or 'DYNAMIC'"},"children":[]}]}]}],"items":{"type":"string","format":"uuid"}},"device_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering by device_type is currently not supported. Please specify 'all'."},"children":[]}]}]}],"enum":["all"]},"command":{"$ref":"#/components/schemas/DeviceCommandEnum"},"command_args":{"$ref":"#/components/schemas/CommandArgs"},"schedule":{"$ref":"#/components/schemas/CommandScheduleEnum"},"schedule_args":{"$ref":"#/components/schemas/CommandScheduleArgs"}}}},"components/schemas/CommandRequestStats":{"id":"components/schemas/CommandRequestStats","kind":"json-schema","title":"CommandRequestStats","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"status":{"type":"array","description":"List of each command status associated to its count.","items":{"type":"object","properties":{"state":{"type":"string","description":"State of the command","enum":["Command Queued","Command Initiated","Command Acknowledged","Command In Progress","Command TimeOut","Command Success","Command Failure","Command Scheduled","Command Cancelled"]},"total":{"type":"number","description":"Count of the devices that are in the corresponding command state"}}}}}}},"components/schemas/CommandStatus":{"id":"components/schemas/CommandStatus","kind":"json-schema","title":"CommandStatus","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique command identifier","format":"uuid","readOnly":true},"request":{"title":"Request Id","type":"string","description":"Request Id associated with this command","format":"uuid","readOnly":true},"device":{"title":"Device","type":"string","description":"Device associated with this command","format":"uuid","readOnly":true},"state":{"type":"string","description":"Current state of the command","enum":["Command Queued","Command Initiated","Command Acknowledged","Command In Progress","Command TimeOut","Command Success","Command Failure","Command Scheduled","Command Cancelled"]},"reason":{"type":"string","description":"details briefing the reason for current command state"},"created_at":{"type":"string","description":"Timestamp of command creation","format":"date-time","readOnly":true},"updated_at":{"type":"string","description":"Last updated timestamp of command","format":"date-time","readOnly":true}}}},"components/schemas/CommandStatus_PUT":{"id":"components/schemas/CommandStatus_PUT","kind":"json-schema","title":"CommandStatus_PUT","data":{"type":"object","properties":{"state":{"type":"string","description":"Command state to update","enum":["Command Acknowledged","Command In Progress","Command TimeOut","Command Success","Command Failure","Command Scheduled","Command Cancelled"]},"reason":{"type":"string","description":"State change reason to update"}}}},"components/schemas/CommandInbox":{"id":"components/schemas/CommandInbox","kind":"json-schema","title":"CommandInbox","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique command identifier","format":"uuid","readOnly":true},"command":{"type":"string","description":"The command to be executed"},"command_args":{"type":"object","description":"Arguments for the command","properties":{"script":{"type":"string","description":"The script to be executed"}}},"device_meta":{"type":"object","description":"Metadata about the device","properties":{"platform":{"type":"string","description":"The platform of the device"}}},"state":{"type":"string","description":"Current state of the command","enum":["Command Queued"]},"created_on":{"type":"string","description":"Timestamp of command creation","format":"date-time","readOnly":true},"updated_on":{"type":"string","description":"Last updated timestamp of command","format":"date-time","readOnly":true}}}},"components/schemas/BlueprintsInfo":{"id":"components/schemas/BlueprintsInfo","kind":"json-schema","title":"BlueprintsInfo","data":{"type":"object","properties":{"blueprint_id":{"type":"string","description":"Unique blueprint ID","format":"uuid"},"blueprint_version_id":{"type":"string","description":"Version ID of blueprint","format":"uuid"}}}},"components/schemas/ScheduleEnum":{"id":"components/schemas/ScheduleEnum","kind":"json-schema","title":"ScheduleEnum","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Following Schedule types are supported"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"* WINDOW: Schedule the command to execute within the given window ```\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"* WINDOW: Schedule the command to execute within the given window ```\n"},"children":[]}]}],"enum":["IMMEDIATE","WINDOW"]}},"components/schemas/Converge":{"id":"components/schemas/Converge","kind":"json-schema","title":"Converge","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique converge identifier","format":"uuid","readOnly":true},"device_id":{"type":"string","description":"ID of the device","format":"uuid"},"converge_with_provision_option":{"type":"boolean"},"blueprint_info":{"type":"object","$ref":"#/components/schemas/BlueprintsInfo"},"schedule_type":{"$ref":"#/components/schemas/ScheduleEnum"},"schedule_args":{"type":"object"},"status":{"type":"string","description":"Current aggregrated status of the converge action","enum":["QUEUED","PROCESSING","IN_PROGRESS","SUCCESS","FAILURE"]},"reason":{"type":"string","description":"details briefing the reason for current converge status"},"created_by":{"type":"string","description":"user id of the user","readOnly":true},"created_at":{"type":"string","description":"Creation timestamp of converge","format":"date-time","readOnly":true},"updated_at":{"type":"string","description":"Updation timestamp of converge","format":"date-time","readOnly":true}}}},"components/schemas/Converge_POST":{"id":"components/schemas/Converge_POST","kind":"json-schema","title":"Converge_POST","data":{"type":"object","properties":{"device_id":{"type":"string","description":"ID of the device","format":"uuid"},"converge_with_provision_option":{"type":"boolean"},"schedule_type":{"$ref":"#/components/schemas/ScheduleEnum"},"schedule_args":{"type":"object"}},"required":["device_id","converge_with_provision_option"]}},"components/schemas/ConvergeCommand":{"id":"components/schemas/ConvergeCommand","kind":"json-schema","title":"ConvergeCommand","data":{"type":"object","properties":{"command_request_id":{"type":"string","description":"ID of the command request","format":"uuid"},"command_state":{"type":"string","description":"Current state of the command","enum":["Command Queued","Command Initiated","Command Acknowledged","Command In Progress","Command TimeOut","Command Success","Command Failure","Command Scheduled","Command Cancelled"]},"reason":{"type":"string","description":"Details briefing the reason for current command state."},"created_at":{"type":"string","description":"Creation timestamp of converge command","format":"date-time","readOnly":true},"updated_at":{"type":"string","description":"Updation timestamp of converge command","format":"date-time","readOnly":true}}}},"components/schemas/SeamlessRequest":{"id":"components/schemas/SeamlessRequest","kind":"json-schema","title":"SeamlessRequest","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"assigned_blueprint_id":{"type":"string","format":"uuid"},"group_id":{"type":"string","format":"uuid","nullable":true},"unique_ids":{"type":"string"},"unique_id_type":{"type":"integer"},"tenant_id":{"type":"string"}}}},"components/schemas/SeamlessInfo":{"id":"components/schemas/SeamlessInfo","kind":"json-schema","title":"SeamlessInfo","data":{"type":"object","properties":{"unique_ids":{"type":"string","example":"3e41fd18-d53d-4673-a10a-23089cbb6b73,3e41fd18-d53d-4673-a10a-23089cbb6b73"},"unique_id_type":{"type":"integer","example":2}}}},"components/schemas/SeamlessRequestBody":{"id":"components/schemas/SeamlessRequestBody","kind":"json-schema","title":"SeamlessRequestBody","data":{"type":"object","properties":{"assigned_blueprint_id":{"type":"string","format":"uuid","example":"3e41fd18-d53d-4673-a10a-23089cbb6b73"},"group_id":{"type":"string","format":"uuid","example":"3e41fd18-d53d-4673-a10a-23089cbb6b73"},"seamless_info":{"$ref":"#/components/schemas/SeamlessInfo"}}}},"components/schemas/DEPSyncDeviceStatus":{"id":"components/schemas/DEPSyncDeviceStatus","kind":"json-schema","title":"DEPSyncDeviceStatus","data":{"type":"object","properties":{"serial":{"type":"string"},"reason":{"type":"string"}}}},"components/schemas/DEPSyncRequestForGetResponse":{"id":"components/schemas/DEPSyncRequestForGetResponse","kind":"json-schema","title":"DEPSyncRequestForGetResponse","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique DEP sync request identifier","format":"uuid","readOnly":true},"status":{"type":"string","description":"Status of the DEP sync request","enum":["QUEUED","INPROGRESS","COMPLETE","FAILURE","SUCCESS"]},"failure_reason":{"type":"string","description":"Reason for DEP Sync failure. If this field is included in the response, a list of devices with which failed to process DEP sync will also be returned in the API response."},"devices":{"type":"object","properties":{"failure":{"type":"array","items":{"$ref":"#/components/schemas/DEPSyncDeviceStatus"}}}},"created_by":{"type":"string","description":"user id of the user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/DEPSyncRequest":{"id":"components/schemas/DEPSyncRequest","kind":"json-schema","title":"DEPSyncRequest","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique DEP sync request identifier","format":"uuid","readOnly":true},"status":{"type":"string","description":"Status of the DEP sync request","enum":["QUEUED","INPROGRESS","COMPLETE","FAILURE","SUCCESS"]},"created_by":{"type":"string","description":"user id of the user"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/APNSCertInfo":{"id":"components/schemas/APNSCertInfo","kind":"json-schema","title":"APNSCertInfo","data":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"apple_id":{"type":"string"},"meta":{"type":"object","properties":{"topic":{"type":"string"},"cert_created_at":{"type":"string","format":"date-time"},"cert_expiry_on":{"type":"string","format":"date-time"}}},"state":{"type":"string","description":"state of APNs certificate upload","enum":["CSR_GENERATED","COMPLETED"]},"created_by":{"type":"number","format":"int32"},"updated_by":{"type":"number","format":"int32"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/APNSCert_PUT":{"id":"components/schemas/APNSCert_PUT","kind":"json-schema","title":"APNSCert_PUT","data":{"type":"object","properties":{"file":{"type":"string","format":"binary"},"apple_id":{"type":"string"}},"required":["file","apple_id"]}},"components/schemas/VPPToken":{"id":"components/schemas/VPPToken","kind":"json-schema","title":"VPPToken","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"tenant_id":{"type":"string","maxLength":64},"key":{"type":"string","maxLength":256},"meta":{"type":"object"},"created_by":{"type":"string","maxLength":64},"updated_by":{"type":"string","maxLength":64},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["tenant_id","created_by","updated_by"]}},"components/schemas/DEP_Token_GET":{"id":"components/schemas/DEP_Token_GET","kind":"json-schema","title":"DEP_Token_GET","data":{"type":"object","properties":{"id":{"type":"string","format":"UUID","description":"id of DEP token"},"token_name":{"type":"string","description":"name of DEP Token"},"meta":{"type":"object","description":"meta information about the DEP token","properties":{"token_expiry_on":{"type":"string"}}},"state":{"type":"string","description":"state of DEP token upload","enum":["CSR_GENERATED","COMPLETED"]},"created_by":{"type":"string","description":"user id of the user"},"updated_by":{"type":"string","description":"user id of the user"},"created_at":{"type":"string","description":"Timestamp of DEP token creation","readOnly":true},"updated_at":{"type":"string","description":"Timestamp of DEP token creation","readOnly":true}}}},"components/schemas/DEP_Token_POST":{"id":"components/schemas/DEP_Token_POST","kind":"json-schema","title":"DEP_Token_POST","data":{"type":"object"}},"components/schemas/BeginGoogleEMMEnrollmentRequest":{"id":"components/schemas/BeginGoogleEMMEnrollmentRequest","kind":"json-schema","title":"BeginGoogleEMMEnrollmentRequest","data":{"type":"object","properties":{"callback_url":{"type":"string"}},"required":["callback_url"]}},"components/schemas/BeginGoogleEMMEnrollmentResponse":{"id":"components/schemas/BeginGoogleEMMEnrollmentResponse","kind":"json-schema","title":"BeginGoogleEMMEnrollmentResponse","data":{"type":"object","properties":{"signup_url":{"type":"string"},"completion_token":{"type":"string"}}}},"components/schemas/GoogleEnterpriseDetails":{"id":"components/schemas/GoogleEnterpriseDetails","kind":"json-schema","title":"GoogleEnterpriseDetails","data":{"type":"object","properties":{"id":{"type":"integer"},"google_enterprise_id":{"type":"string"},"name":{"type":"string"},"state":{"type":"integer"},"callback_url":{"type":"string"},"signup_url":{"type":"string"},"completion_token":{"type":"string"},"enterprise_token":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"tenant_id":{"type":"string"}}}},"components/schemas/CreateWebTokenRequest":{"id":"components/schemas/CreateWebTokenRequest","kind":"json-schema","title":"CreateWebTokenRequest","data":{"type":"object","properties":{"google_enterprise_id":{"type":"string","description":"The ID of the Google enterprise. It is required and cannot be empty.","example":"test","minLength":1},"parent_url":{"type":"string","description":"The parent URL. It must be a valid URL with the https scheme.","format":"uri","example":"https://valid.url","pattern":"^https://"}},"required":["google_enterprise_id","parent_url"]}},"components/schemas/CreateWebTokenResponse":{"id":"components/schemas/CreateWebTokenResponse","kind":"json-schema","title":"CreateWebTokenResponse","data":{"type":"object","properties":{"token":{"type":"string","description":"The generated token.","example":"test_1245"}}}},"components/schemas/GoogleServiceAccountDetails":{"id":"components/schemas/GoogleServiceAccountDetails","kind":"json-schema","title":"GoogleServiceAccountDetails","data":{"type":"object","properties":{"tenant_id":{"type":"string"},"google_enterprise_id":{"type":"string"},"name":{"type":"string"},"key_id":{"type":"string"},"type":{"type":"integer"},"is_set":{"type":"boolean"},"is_active":{"type":"boolean"},"data":{"type":"string"},"public_data":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/Build_V1":{"id":"components/schemas/Build_V1","kind":"json-schema","title":"Build_V1","data":{"type":"object","properties":{"build_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"deprecated_on":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"updated_by":{"type":"string"},"ab_update":{"type":"boolean"},"android_major_version":{"type":"integer"},"android_minimum_sdk_level":{"type":"integer"},"android_minor_version":{"type":"string"},"android_sdk_level":{"type":"integer"},"build_arch":{"type":"string"},"build_flavor":{"type":"string"},"build_hash":{"type":"string"},"build_ota_hash":{"type":"string"},"build_job_url":{"type":"string"},"build_job_id":{"type":"integer"},"build_fingerprint_hash":{"type":"string"},"build_type":{"type":"string"},"build_url":{"type":"string","format":"url"},"build_update_meta_data":{"type":"string","format":"json"},"build_update_url":{"type":"string","format":"url"},"file_size_kb":{"type":"integer"},"foundation_build_number":{"type":"integer"},"foundation_major_number":{"type":"integer"},"foundation_minor_number":{"type":"integer"},"foundation_name":{"type":"string"},"model_display_name":{"type":"string"},"build_job_params":{"type":"string","format":"json"},"prebuilt_app_info":{"type":"string","format":"json"},"release_notes":{"type":"string","format":"json"},"release_rating":{"type":"string"},"source_build_id":{"type":"string"},"build_state":{"type":"string","enum":["released","to_be_deprecated","unavailable"]},"device_model_id":{"type":"string"},"approved":{"type":"boolean"}}}},"components/schemas/Foundry_Build_PUT_Request_V1":{"id":"components/schemas/Foundry_Build_PUT_Request_V1","kind":"json-schema","title":"Foundry_Build_PUT_Request_V1","data":{"type":"object","properties":{"approve":{"type":"boolean"},"user_remarks":{"type":"string"}}}},"components/schemas/Device_Model_V1":{"id":"components/schemas/Device_Model_V1","kind":"json-schema","title":"Device_Model_V1","data":{"type":"object","properties":{"model_display_name":{"type":"string","example":"Motorola Edge 20 - T2E20"},"manufacturer":{"type":"string","example":"Motorola"},"model":{"type":"string","example":"Edge 20"},"profile_name":{"type":"string","example":"Tacobell"},"profile_variant":{"type":"string","example":"T2E20"},"update_compatible_android_api_level_begin":{"type":"integer","example":11},"device_model_id":{"type":"string","format":"uuid","example":"eb566c45-f841-41e5-a0af-435e90a96cae"},"auto_update":{"type":"boolean","example":false},"latest":{"type":"boolean","example":false},"locked_build_id":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2023-12-07T17:14:46.419449+05:30"},"updated_at":{"type":"string","format":"date-time","example":"2023-12-07T17:14:46.419449+05:30"},"created_by":{"type":"string","example":"FoundryAdmin"},"updated_by":{"type":"string","example":"FoundryAdmin"}}}},"components/schemas/Device_Model_PUT_Request_V1":{"id":"components/schemas/Device_Model_PUT_Request_V1","kind":"json-schema","title":"Device_Model_PUT_Request_V1","data":{"type":"object","properties":{"auto_update":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enables/disables automatic updates for the device model. The other properties (latest and locked_build_id) are processed only if autoupdate is set to true."},"children":[]}]}]}]},"latest":{"type":"boolean","description":"Configures Foundry service to automatically lock to the latest approved build (whenever available) if set to true."},"locked_build_id":{"type":"string","description":"Specifies the UUID of the build which needs to be locked for automatic updates."}}}},"components/schemas/Foundry_Event_V1":{"id":"components/schemas/Foundry_Event_V1","kind":"json-schema","title":"Foundry_Event_V1","data":{"type":"object","properties":{"stack":{"type":"string"},"tenant":{"type":"string"},"enterprise_id":{"type":"string"},"actor":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"event_message":{"type":"string"},"event_type":{"type":"string"},"resource":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}},"meta":{"type":"object","properties":{"user_remarks":{"type":"string"},"change_type":{"type":"string"},"device_model":{"type":"string"}}},"created_timestamp":{"type":"integer"}}}},"components/schemas/GetReportTypesResponse":{"id":"components/schemas/GetReportTypesResponse","kind":"json-schema","title":"GetReportTypesResponse","data":{"type":"object","properties":{"content":{"type":"object","properties":{"report_types":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"display_name":{"type":"string"},"description":{"type":"string"},"last_generated_at":{"type":"string"},"available_from":{"type":"string"}}}}}}}}},"components/schemas/ReportsErrorResponse":{"id":"components/schemas/ReportsErrorResponse","kind":"json-schema","title":"ReportsErrorResponse","data":{"type":"object","properties":{"status":{"type":"integer"},"error":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/DeviceAppsFilter":{"id":"components/schemas/DeviceAppsFilter","kind":"json-schema","title":"DeviceAppsFilter","data":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2024-08-28","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of report. If provided, this value will override start_time and end_time values. Example: \"2024-08-28\". Must be a date later than July 1st, 2024."},"children":[]}]}]}]},"package_name":{"type":"array","nullable":true,"items":{"type":"string"},"example":["com.android.chrome"]},"app_state":{"type":"array","nullable":true,"items":{"type":"string","enum":["SHOW","HIDE","DISABLE","LAUNCHABLE_BUT_HIDDEN"]},"example":["SHOW"]},"device_os":{"type":"array","nullable":true,"items":{"type":"string","enum":["Android","iOS"]},"example":["Android"]},"platform":{"type":"array","nullable":true,"items":{"type":"string","enum":["Android","Apple","Linux","Windows"]},"example":["Android"]}}}},"components/schemas/DeviceFilter":{"id":"components/schemas/DeviceFilter","kind":"json-schema","title":"DeviceFilter","data":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2025-03-17","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of report. If provided, this value will override start_time and end_time values. Example: \"2025-03-17\". Must be a date later than May 17th, 2025."},"children":[]}]}]}]},"platform":{"type":"array","nullable":true,"items":{"type":"string","enum":["Android","Apple","Linux","Windows"]},"example":["Android"]}}}},"components/schemas/Report":{"id":"components/schemas/Report","kind":"json-schema","title":"Report","data":{"type":"object","properties":{"report_type":{"type":"string","enum":["device_apps","device"],"example":"device_apps"},"start_time":{"description":"Start time of the report in UTC format. Example: \"2024-08-28T00:00:00Z\". Must be a date and time later than July 1st, 2024.","type":"string","format":"date-time","example":"2024-08-28T00:00:00Z"},"end_time":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End time of the report in UTC format. Example: \"2024-08-29T00:00:00Z\". Must be a date and time later than July 1st, 2024 and equal to the start_time."},"children":[]}]}]}],"type":"string","format":"date-time","example":"2024-08-28T00:00:00Z"},"is_download":{"type":"boolean"},"filters":{"type":"object","nullable":true,"oneOf":[{"$ref":"#/components/schemas/DeviceAppsFilter"},{"$ref":"#/components/schemas/DeviceFilter"}]}},"required":["report_type"]}},"components/schemas/CreateReportResponse":{"id":"components/schemas/CreateReportResponse","kind":"json-schema","title":"CreateReportResponse","data":{"type":"object","properties":{"content":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED","CANCELED","CLOSED"]}}}}}},"components/schemas/GetReportResponsePreview":{"id":"components/schemas/GetReportResponsePreview","kind":"json-schema","title":"GetReportResponsePreview","data":{"type":"object","properties":{"content":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED","CANCELED","CLOSED"]},"schema":{"type":"object","properties":{"column_count":{"type":"integer"},"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"integer"},"type_name":{"type":"string"},"type_text":{"type":"string"}}}}}},"data_array":{"type":"array","items":{"type":"array","items":{"type":"string"}}}}}}}},"components/schemas/GetReportResponseDownload":{"id":"components/schemas/GetReportResponseDownload","kind":"json-schema","title":"GetReportResponseDownload","data":{"type":"object","properties":{"content":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["PENDING","RUNNING","SUCCEEDED","FAILED","CANCELED","CLOSED"]},"schema":{"type":"object","properties":{"column_count":{"type":"integer"},"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"integer"},"type_name":{"type":"string"},"type_text":{"type":"string"}}}}}},"external_link":{"type":"string"}}}}}},"schema_299":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"type":"string"},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"string","format":"datetime"},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"integer","default":20},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}}},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"string","enum":["AVAILABLE","ACCEPTED","APPROVED","REJECTED"]},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/AppVersion"}}}},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"object","properties":{"release_name":{"title":"Release name","type":"string","description":"Name of the Release"},"release_comments":{"title":"Release comments","type":"string","description":"Additional comments about the release"},"release_track":{"title":"Release track","type":"string","description":"Description of the content","enum":["Alpha","Beta","Production"]},"is_enabled":{"title":"Is Enabled","type":"boolean","description":"Is the app version enabled"},"min_sdk_version":{"title":"Minimum SDK version","type":"string","description":"Version number of minimum SDK version that supports this app version"},"target_sdk_version":{"title":"Target SDK version","type":"string","description":"Target SDK version that supports this app version"},"build_number":{"title":"Build Number","type":"string","description":"Build number of this app version"},"version_code":{"title":"Version Code","type":"string","description":"Verion code of this app version"},"approval_status":{"title":"Approval Status","type":"string","description":"Approval status of this app version","enum":["AVAILABLE","ACCEPTED","APPROVED","REJECTED"]},"is_default":{"title":"Is default","type":"boolean","description":"Is the app version default"}}},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/InstallDevices"}}}},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"required":["app_file"],"properties":{"app_file":{"type":"string","description":"Valid APK file","format":"binary"}}},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/Application"}}},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleEnterprise"}}}},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleWebToken"}}}},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleProduct"}}}},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"object","properties":{"icon_url":{"type":"string","format":"url"},"is_active":{"title":"Is Active","type":"boolean"},"updated_on":{"type":"string","format":"date-time"},"min_sdk_version":{"title":"Minimum SDK Version","type":"integer"},"unapproved":{"type":"boolean","title":"Unapproving an app deletes it"}}},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"type":"object","properties":{"icon_url":{"type":"string","format":"url"},"is_active":{"title":"Is Active","type":"boolean"},"updated_on":{"type":"string","format":"date-time"},"min_sdk_version":{"title":"Minimum SDK Version","type":"integer"}}},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleProductInstall"}}}},"id":"schema_320"},"schema_321":{"kind":"json-schema","data":{"required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"properties":{"id":{"type":"string","format":"uuid"},"package_name":{"type":"string"}}}}}},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationV1"}}}},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/AppVersionV1"}}}},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"type":"object","properties":{"release_name":{"title":"Release name","type":"string","description":"Name of the Release"},"is_default":{"title":"Is Default","type":"boolean","description":"Is the app version the deafult"},"min_sdk_version":{"title":"Minimum SDK version","type":"string","description":"Version number of minimum SDK version that supports this app version"},"build_number":{"title":"Build Number","type":"string","description":"Build number of this app version"},"version_code":{"title":"Version Code","type":"string","description":"Verion code of this app version"},"approval_status":{"title":"Approval Status","type":"string","description":"Approval status of this app version","enum":["AVAILABLE","ACCEPTED","APPROVED","REJECTED"]}}},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"$ref":"#/components/schemas/DeviceStateEnum"},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"next":{"type":"string","format":"url"},"previous":{"type":"string","format":"url"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfo"}}}},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceApp"}}}},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/AppInstall"}}}},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceStatus"}}}},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"type":"integer","default":250},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/EventFeed"}}}},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/V0CommandRequest"}}}},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceGroup"}}}},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"type":"object","properties":{"image_file":{"type":"string","format":"binary"}}},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/GroupThumbnail"}}}},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"required":["content"],"type":"object","properties":{"content":{"items":{"$ref":"#/components/schemas/DeviceSubGroup"}}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"next":{"type":"string","format":"url"},"previous":{"type":"string","format":"url"},"results":{"type":"array","items":{"$ref":"#/components/schemas/V0CommandRequest"}}}},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"next":{"type":"string","format":"url"},"previous":{"type":"string","format":"url"},"results":{"type":"array","items":{"$ref":"#/components/schemas/V0CommandStatus1"}}}},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"next":{"type":"string","format":"url"},"previous":{"type":"string","format":"url"},"results":{"type":"array","items":{"$ref":"#/components/schemas/V0CommandStatus"}}}},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/EnterprisePolicy"}}}},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Geofence"}}}},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Content"}}}},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"type":"object","properties":{"tags":{"title":"Tags","type":"array","description":"Tags for the content","items":{"maxLength":255,"type":"string"}},"description":{"title":"Description","type":"string","description":"Description of the content"}}},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"required":["key"],"properties":{"key":{"type":"string","description":"Valid file to upload","format":"binary"}}},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"required":["file"],"properties":{"file":{"type":"string","description":"The file to upload (max 50MB)","format":"binary"},"filename":{"type":"string","description":"Custom filename (optional, defaults to uploaded file name)"},"content_type":{"type":"string","description":"MIME type of the file (optional, auto-detected)"}}},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"object","properties":{"file_key":{"type":"string","description":"Unique storage key for the file","example":"123/files/document_abc123.pdf"},"bucket":{"type":"string","description":"Storage bucket name","example":"REMOTE_FILE_MANAGER"},"file_size":{"type":"integer","description":"Size of uploaded file in bytes","example":1048576},"content_type":{"type":"string","description":"Detected/validated MIME type","example":"application/pdf"},"auto_delete_after_minutes":{"type":"integer","description":"When file will be auto-deleted","example":1440},"download_url":{"type":"string","description":"Pre-signed URL for downloading the file","example":"https://s3.amazonaws.com/REMOTE_FILE_MANAGER/123/files/document_abc123.pdf?AWSAccessKeyId=..."},"download_expires_in":{"type":"integer","description":"Download URL expiration time in seconds","example":3600}}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"No file provided"}}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"File size exceeds maximum allowed size of 52428800 bytes"}}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Failed to upload file"}}},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"required":["file_key"],"properties":{"file_key":{"type":"string","description":"The storage key of the file to download","example":"123/files/document_abc123.pdf"},"expires_in":{"type":"integer","description":"URL expiration time in seconds (optional, default 3600)","default":3600,"minimum":60,"maximum":86400}}},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"object","properties":{"file_key":{"type":"string","description":"The storage key of the file","example":"123/files/document_abc123.pdf"},"download_url":{"type":"string","description":"Pre-signed URL for downloading the file","example":"https://s3.amazonaws.com/REMOTE_FILE_MANAGER/123/files/document_abc123.pdf?AWSAccessKeyId=..."},"expires_in":{"type":"integer","description":"URL expiration time in seconds","example":3600}}},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"file_key is required"}}},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string","example":"Failed to generate download URL"}}},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"userinvites":{"type":"array","items":{"$ref":"#/components/schemas/TenantUserInviteResponse"}}}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/UserList"}}}},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string"},"previous":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Blueprint"}}}},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string"},"previous":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BlueprintRevision"}}}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"object","properties":{"revision_id":{"type":"string","format":"uuid"}}},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DirectoryRecord"}}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/TileIcon"}}}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"required":["icon_file","device_model","enterprise"],"properties":{"icon_file":{"type":"string","description":"Valid file to upload","format":"path"},"device_model":{"type":"string","description":"Device model"},"enterprise":{"type":"string","format":"uuid","description":"UUID string representing enterprise of tile icon"}}},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"required":["model"],"properties":{"model":{"type":"string","description":"Model of device"}}},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"properties":{"model":{"type":"string","description":"Model of device"}}},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/AlertChannelsV1"}}}},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/AlarmRule"}}}},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Wallpaper"}}}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"required":["image_file","orientation"],"properties":{"image_file":{"type":"string","description":"Valid file to upload","format":"path"},"orientation":{"type":"string","description":"Orientation of image e.g. landscape"}}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceLocations"}}}},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"type":"number","format":"double"},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"$ref":"#/components/schemas/SecurityStatesEnum"},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"string","description":"Add group names to filter by comma separating"},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"type":"string","format":"uuid","description":"Add group UUID to filter by comma separating"},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"string","format":"boolean","description":"Allowed values are True, False, true, false, 1, 0."},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"type":"integer","description":"List of android versions- comma separated."},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"type":"string","description":"List of network types, comma separated."},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"type":"string","description":"List of templates, comma separated."},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"type":"string","description":"List of policy names, comma separated."},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"type":"string","description":"City or state can be used to filter location."},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceTiles"}}}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"object","properties":{"reportAvailabilityFrom":{"type":"string","format":"date-time"},"enableReportsWorkflow":{"type":"boolean"}}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"type":"array","items":{"properties":{"group_id":{"type":"string","format":"uuid"},"group_name":{"type":"string"},"group_path":{"type":"string"},"active_devices":{"type":"integer"},"inactive_devices":{"type":"integer"},"registered_devices":{"type":"integer"},"new_devices":{"type":"integer"},"disabled_devices":{"type":"integer"},"device_status_reports":{"type":"array","items":{"$ref":"#/components/schemas/DeviceStatusReport"}}}}},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"type":"object","properties":{"peak_active_devices":{"type":"integer"},"provisioned_devices":{"type":"integer"},"registered_devices":{"type":"integer"}}},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/GroupReport"}},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"url","nullable":true},"previous":{"type":"string","format":"url","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"required":["email_ids"],"properties":{"email_ids":{"type":"array","items":{"type":"string","format":"email"}}}},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"required":["email_ids"],"properties":{"email_ids":{"type":"array","items":{"type":"string","format":"email"}},"is_subscribed":{"type":"boolean"}}},"id":"schema_388"},"schema_389":{"kind":"json-schema","data":{"properties":{"email_ids":{"type":"array","items":{"type":"string","format":"email"}},"is_subscribed":{"type":"boolean"}}},"id":"schema_389"},"schema_390":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"connections":{"type":"array","items":{"$ref":"#/components/schemas/CustomConnectionsListResponse"}}}},"id":"schema_390"},"schema_391":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleResponse"}}}},"id":"schema_391"},"schema_392":{"kind":"json-schema","data":{"type":"object","properties":{"scope_ids":{"type":"array","items":{"type":"string"}},"scope_names":{"type":"array","items":{"type":"string","enum":["read:device","read:group","read:blueprint","read:directory_record","create:device_command:SET_DEVICE_LOCKDOWN_STATE","create:device_command:REBOOT","create:device_command:BEEP_DEVICE","create:device_command:WIPE","create:device_command:UPDATE_HEARTBEAT","create:device_command:NOTIFY_DEVICE","create:device_command:LOCK","create:device_command:SET_KIOSK_APP","update:device:group","create:device:tag","update:device:tag","delete:device:tag","update:device:alias","create:template_upgrade","create:device_command:SET_STREAM_VOLUME","create:device_command:SET_BRIGHTNESS_SCALE","create:device_command:SET_ROTATION_STATE","create:device_command:SET_SCREEN_OFF_TIMEOUT","create:device_command:SET_WALLPAPER","create:device_command:SET_WIFI_STATE","create:device_command:ADD_WIFI_AP","create:device_command:REMOVE_WIFI_AP","create:device_command:SET_STATIC_IP","create:device_command:SET_ETHERNET_SETTINGS","create:device_command:SET_GPS_STATE","create:device_command:SET_BLUETOOTH_STATE","create:device_command:SET_TIMEZONE","create:device_command:SET_ADB_STATE","create:device_command:UPDATE_DEVICE_CONFIG","create:device_command:UPDATE_BLUEPRINT","create:device_command:SHUT_DOWN","create:device_command:CLEAR_PASSCODE","create:device_command:LOST_MODE","read:device_app","create:device_command:REFRESH_APPLIST","create:device_command:INSTALL","create:device_command:INSTALL_APP","create:device_command:UNINSTALL","create:device_command:UNINSTALL_APP","create:device_command:SET_APP_STATE","create:device_command:CLEAR_APP_DATA","create:device_command:SET_APP_PERMISSION","create:device_command:REQUEST_BUGREPORT","create:device_command:SET_NEW_POLICY","create:group_command:SET_NEW_POLICY","create:group","create:group_command:REBOOT","create:group_command:LOCK","create:group_command:UPDATE_HEARTBEAT","create:group_command:WIPE","create:group_command:NOTIFY_DEVICE","create:group_command:SET_KIOSK_APP","create:group_command:SET_STREAM_VOLUME","create:group_command:SET_BRIGHTNESS_SCALE","create:group_command:SET_ROTATION_STATE","create:group_command:SET_SCREEN_OFF_TIMEOUT","create:group_command:SET_WALLPAPER","create:group_command:SET_WIFI_STATE","create:group_command:ADD_WIFI_AP","create:group_command:REMOVE_WIFI_AP","create:group_command:SET_STATIC_IP","create:group_command:SET_ETHERNET_SETTINGS","create:group_command:SET_GPS_STATE","create:group_command:SET_BLUETOOTH_STATE","create:group_command:SET_TIMEZONE","create:group_command:SET_ADB_STATE","create:group_command:UPDATE_DEVICE_CONFIG","create:group_command:UPDATE_BLUEPRINT","create:group_command:INSTALL","create:group_command:INSTALL_APP","create:group_command:UNINSTALL","create:group_command:UNINSTALL_APP","create:group_command:SET_APP_STATE","create:device_command:INITIATE_OFFER","read:device_screenshot","create:device_command:CAPTURE_SCREENSHOT","create:device_screenshot","read:device_graph","read:event_feed","create:blueprint","update:blueprint","delete:blueprint","create:device_command:CONVERGE","update:device:blueprint","update:group:blueprint","provision:device","read:compliance_policy","create:compliance_policy","update:compliance_policy","delete:compliance_policy","read:provisioning_template","create:provisioning_template","update:provisioning_template","delete:provisioning_template","create:provisioning_template:imei_serial","update:provisioning_template:imei_serial","delete:provisioning_template:imei_serial","update:provisioning_template:wifi_management","read:app","read:emm","create:emm","update:emm","create:app:esper_android","update:app:esper_android","delete:app:esper_android","read:alert","read:pipeline","read:geofence","read:report","create:report","read:personal_access_token","create:personal_access_token","update:personal_access_token","delete:personal_access_token","read:foundation_build","read:foundation_device_model","update:foundation_build","update:foundation_device_model","read:foundry_event","update:command","read:user:group","create:app:esper_ios","update:app:esper_ios","delete:app:esper_ios","create:operation:CONVERGE","create:operation:REBOOT","create:operation:INSTALL","create:operation:UNINSTALL","create:operation:APP_INSTALL","create:operation:APP_UNINSTALL","read:operation","update:operation","read:operation:devices","read:device:operations","update:operation:devices","create:device_command:RUN_SHELL_SCRIPT","create:remote_terminal","read:report:query","create:report:query","read:report:saved_query","create:report:saved_query","update:report:saved_query","delete:report:saved_query","create:device_command:REMOVE_DEVICE","read:report:ingest","create:report:ingest","read:esper_apps","create:device_command:RUN_CUSTOM_ACTION","create:device_command:LIST_RESTRICTED_PROFILES","create:device_command:LIST_PROVISIONING_PROFILES","create:group_command:SYNC_CONTENT","create:device_command:SYNC_CONTENT"]}}}},"id":"schema_392"},"schema_393":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"scopes":{"type":"array","items":{"$ref":"#/components/schemas/ScopeResponse"}}}},"id":"schema_393"},"schema_394":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","description":"name for the token."},"description":{"type":"string","description":"description for the token."},"expiry_at":{"type":"integer","description":"exipy date for token."}},"required":["name","description","expiry_at"]},"id":"schema_394"},"schema_395":{"kind":"json-schema","data":{"type":"object","properties":{"expiry_at":{"type":"integer","description":"exipy date for token."}},"required":["expiry_at"]},"id":"schema_395"},"schema_396":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","format":"int64","description":"The number of objects in the result set"},"next":{"type":"string","description":"The link to retrieve the next set of objects in the result set"},"previous":{"type":"string","description":"The link to retrieve the previous set of objects in the result set"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BlueprintV2"}},"message":{"type":"string"},"code":{"type":"integer"}}}}},"id":"schema_396"},"schema_397":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/BlueprintV2"},"message":{"type":"string"},"code":{"type":"integer","enum":[201]}}},"id":"schema_397"},"schema_398":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"string"},"message":{"type":"string"},"code":{"type":"integer","enum":[400]}}},"id":"schema_398"},"schema_399":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object"},"message":{"type":"string"},"code":{"type":"integer","enum":[404]}}},"id":"schema_399"},"schema_400":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/BlueprintV2"},"message":{"type":"string"},"code":{"type":"string","enum":[201]}}},"id":"schema_400"},"schema_401":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"string"},"message":{"type":"string"},"code":{"type":"string","enum":[3456]}}},"id":"schema_401"},"schema_402":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object"},"message":{"type":"string"},"code":{"type":"string","enum":[3456]}}},"id":"schema_402"},"schema_403":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object"},"message":{"type":"string"},"code":{"type":"string","enum":[201]}}},"id":"schema_403"},"schema_404":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":100,"default":10},"id":"schema_404"},"schema_405":{"kind":"json-schema","data":{"type":"integer","minimum":0,"default":0},"id":"schema_405"},"schema_406":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","format":"int64","description":"The total number of custom actions"},"next":{"type":"string","nullable":true,"description":"The link to retrieve the next set of objects in the result set"},"previous":{"type":"string","nullable":true,"description":"The link to retrieve the previous set of objects in the result set"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomActionRead"}}}},"message":{"type":"string"},"code":{"type":"integer"}}},"id":"schema_406"},"schema_407":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"code":{"type":"integer","enum":[400]}}},"id":"schema_407"},"schema_408":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/CustomActionRead"},"message":{"type":"string"},"code":{"type":"integer","enum":[201]}}},"id":"schema_408"},"schema_409":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object"}},"message":{"type":"string"},"code":{"type":"integer","enum":[400]}}},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","enum":[409]}}},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","enum":[500]}}},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/CustomActionRead"},"message":{"type":"string"},"code":{"type":"integer","enum":[200]}}},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","enum":[404]}}},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","enum":[400]}}},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","enum":[200]}}},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/platformScript"},"message":{"type":"string"},"code":{"type":"integer","enum":[200]}}},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer","enum":[403]}}},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"type":"boolean","enum":[true,false]},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"type":"string","enum":["name","-name"]},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}}}}}},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/Pipeline"}}},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Stage"}}}}}},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/Stage"}}},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"string","enum":["groups","devices","collections"]},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TargetList"}}}}}},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/TargetList"}}},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Target"}}}}}},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/Target"}}},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"oneOf":[{"type":"array","items":{"type":"string","description":"Device ID"},"example":[{"device_id":"18d21907-a3b3-491b-9237-d835de82a3ef","device_name":"ESPR-LAB-AAA03","device_alias":"Actineon Edge 10A"},{"device_id":"550e8400-e29b-41d4-a716-446655440002","device_name":"ESPR-LAB-AAA04","device_alias":"Actineon Edge 10B"}]},{"type":"array","items":{"type":"object","required":["device_id"],"properties":{"device_id":{"type":"string","description":"Device ID (UUID)"},"device_name":{"type":"string","description":"Device name (should be provided for proper target run creation)"},"device_alias":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device alias (optional, stored in device_meta)"},"children":[]}]}]}]},"device_meta":{"type":"object","description":"Device metadata (optional)"},"args":{"type":"object","description":"Custom arguments (optional)"},"is_active":{"type":"boolean","description":"Active status (optional, defaults to true)"}}}}]},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","example":200},"message":{"type":"string","example":"Bulk add completed. 2 target(s) created, 5 target(s) added to list, 1 target(s) skipped."},"content":{"type":"object","properties":{"created_count":{"type":"integer","description":"Number of new target records created","example":2},"added_count":{"type":"integer","description":"Number of targets successfully added to the list","example":5},"skipped_count":{"type":"integer","description":"Number of targets that were already in the list","example":1},"errors":{"type":"array","items":{"type":"object"},"description":"List of any errors encountered","example":[]}}}}},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TargetListDeviceGroup"}}}}}},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"array","items":{"type":"string","format":"uuid"}}}},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Device"}}}}}},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/OperationList"}}}}}},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/OperationList"}}},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}}}}},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/Operation"}}},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"type":"string","enum":["pending","queued","processing","running","waiting","complete","success","failure","cancelled","invalid","timeout"]},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"type":"string","enum":["run_number","-run_number","status","-status","pipeline__name","-pipeline__name","started_at","-started_at","ended_at","-ended_at"]},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PipelineRun"}}}}}},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"type":"string","enum":["run_number","-run_number","status","-status","started_at","-started_at","ended_at","-ended_at"]},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/PipelineRun"}}},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"string","enum":["pending","queued","processing","running","complete","success","failure","cancelled","invalid","timeout"]},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/StageRun"}}}}}},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/StageRun"}}},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["pending","queued","processing","running","complete","success","failure","cancelled","invalid","timeout"]}}},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/StageRunOperation"}}}}}},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/StageRunOperation"}}},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"type":"string","enum":["pending","queued","processing","dispatched","running","complete","success","failure","cancelled","invalid","timeout"]},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"type":"string","enum":["status","-status"]},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TargetRun"}}}}}},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"array","items":{"$ref":"#/components/schemas/TargetRun"}}}},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/TargetRun"}}},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/CommandResponse"}}},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"type":"string","enum":["alias","created_at","last_seen","model","os_version","name","onboarded_on","serial","provisioned_on","battery_level","dpc_version","eea_version","is_gms","security_state","wifi_ssid","platform","template_name"]},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"type":"string","enum":["ANDROID","APPLE","LINUX","WINDOWS"]},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"type":"string","enum":["iOS","iPadOS","tvOS","Android","Linux","Windows"]},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AndroidDevice"},{"$ref":"#/components/schemas/AppleDevice"},{"$ref":"#/components/schemas/LinuxDevice"},{"$ref":"#/components/schemas/WindowsDevice"}]}}}}}},"id":"schema_458"},"schema_459":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"oneOf":[{"$ref":"#/components/schemas/AppleDevice"},{"$ref":"#/components/schemas/AndroidDevice"},{"$ref":"#/components/schemas/LinuxDevice"},{"$ref":"#/components/schemas/WindowsDevice"}]}}},"id":"schema_459"},"schema_460":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"oneOf":[{"$ref":"#/components/schemas/AppleDevice"},{"$ref":"#/components/schemas/LinuxDevice"},{"$ref":"#/components/schemas/WindowsDevice"}]}}},"id":"schema_460"},"schema_461":{"kind":"json-schema","data":{"type":"integer","default":10},"id":"schema_461"},"schema_462":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of distinct foundation versions"},"prev":{"type":"string","description":"URL to the previous page of results"},"next":{"type":"string","description":"URL to the next page of results"},"results":{"type":"array","items":{"type":"object","properties":{"foundation_version":{"type":"string","description":"The foundation version string"}}}}}},"id":"schema_462"},"schema_463":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/EsperDeviceHeartbeat"}}},"id":"schema_463"},"schema_464":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2023-08-29T00:00:00Z"},"id":"schema_464"},"schema_465":{"kind":"json-schema","data":{"type":"string","format":"date-time","example":"2023-08-30T00:00:00Z"},"id":"schema_465"},"schema_466":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/DeviceLastSeen"}}},"id":"schema_466"},"schema_467":{"kind":"json-schema","data":{"type":"string","enum":["VPP","TENANT_IOS","ESPER_IOS","WEBCLIP","ESPER_WINDOWS","TENANT_WINDOWS"]},"id":"schema_467"},"schema_468":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAppsResponse"}}}},"id":"schema_468"},"schema_469":{"kind":"json-schema","data":{"type":"integer","format":"uuid"},"id":"schema_469"},"schema_470":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"prev":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"device_id":{"type":"string","format":"uuid"}}}}}},"id":"schema_470"},"schema_471":{"kind":"json-schema","data":{"type":"string","default":"false"},"id":"schema_471"},"schema_472":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/GoogleEMMDevice"}}},"id":"schema_472"},"schema_473":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleAccount"}}}}}},"id":"schema_473"},"schema_474":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/GoogleAccountUpdateResponseBody"}}},"id":"schema_474"},"schema_475":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/GoogleAccount"}}},"id":"schema_475"},"schema_476":{"kind":"json-schema","data":{"type":"string","enum":["created_at","state","updated_at"]},"id":"schema_476"},"schema_477":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/OperationWithStats"}}}}}},"id":"schema_477"},"schema_478":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/OperationWithStats"}}},"id":"schema_478"},"schema_479":{"kind":"json-schema","data":{"type":"string","example":"5743470f-7dcc-4a92-8a4b-f41b1cea69ed"},"id":"schema_479"},"schema_480":{"kind":"json-schema","data":{"type":"object","properties":{"state":{"type":"string","enum":["FAILED","CANCELLED","TIMEOUT","SCHEDULED"],"description":"The new status of the operation"}},"required":["status"]},"id":"schema_480"},"schema_481":{"kind":"json-schema","data":{"type":"object","properties":{"operationId":{"type":"string","description":"The ID of the updated operation"},"status":{"type":"string","description":"The updated status of the operation"}}},"id":"schema_481"},"schema_482":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DeviceOperationWithStats"}}}}}},"id":"schema_482"},"schema_483":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/OperationWithStats"}}}},"id":"schema_483"},"schema_484":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"5743470f-7dcc-4a92-8a4b-f41b1cea69ed"},"id":"schema_484"},"schema_485":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"17d384d3-29bd-4dd4-af64-d02b9d6d54ee"},"id":"schema_485"},"schema_486":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/DeviceOperationWithStats"}}},"id":"schema_486"},"schema_487":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"0aae03d2-32b4-4cab-b733-6919b84bb2ac"},"id":"schema_487"},"schema_488":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"id":"schema_488"},"schema_489":{"kind":"json-schema","data":{"type":"object","properties":{"operation_type":{"type":"string","example":"CONVERGE"},"state":{"type":"string","example":"SUCCESS"},"service_id":{"type":"string","example":"drift-service"},"reason":{"type":"string","example":"test"}}},"id":"schema_489"},"schema_490":{"kind":"json-schema","data":{"type":"string","enum":["INITIATED","ACKNOWLEDGED","ACTIVE","TERMINATED","FAILED"],"description":"List API supports comma separated states."},"id":"schema_490"},"schema_491":{"kind":"json-schema","data":{"type":"string","enum":["STANDARD","DATA_SAVER"],"description":"To allow filtering sessions list by comma separated video qualities"},"id":"schema_491"},"schema_492":{"kind":"json-schema","data":{"type":"string","description":"To allow searching sessions list by reason"},"id":"schema_492"},"schema_493":{"kind":"json-schema","data":{"type":"string","description":"To allow filtering sessions list by created by"},"id":"schema_493"},"schema_494":{"kind":"json-schema","data":{"type":"string","description":"To allow searching sessions list by device name"},"id":"schema_494"},"schema_495":{"kind":"json-schema","data":{"type":"string","default":"-created_at","enum":["created_at","updated_at","device_name","duration","state","reason","video_quality","created_by"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To allow ordering sessions list by created_at, updated_at, device_name, duration, state, reason, video_quality and created_by."},"children":[]}]}]}]},"id":"schema_495"},"schema_496":{"kind":"json-schema","data":{"type":"string","format":"duration","description":"Duration less than filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).","example":"duration_lt=PT10M30S"},"id":"schema_496"},"schema_497":{"kind":"json-schema","data":{"type":"string","format":"duration","description":"Duration less than or equal to filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).","example":"duration_lte=PT10M30S"},"id":"schema_497"},"schema_498":{"kind":"json-schema","data":{"type":"string","format":"duration","description":"Duration greater than filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).","example":"duration_gt=PT10M30S"},"id":"schema_498"},"schema_499":{"kind":"json-schema","data":{"type":"string","format":"duration","description":"Duration greater than or equal to filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).","example":"duration_gte=PT10M30S"},"id":"schema_499"},"schema_500":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Created at less than filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"created_at_lt=2023-10-01T12:00:00Z"},"id":"schema_500"},"schema_501":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Created at greater than filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"created_at_gt=2023-10-01T12:00:00Z"},"id":"schema_501"},"schema_502":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Created at less than or equal to filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"created_at_lte=2023-10-01T12:00:00Z"},"id":"schema_502"},"schema_503":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Created at greater than or equal to filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"created_at_gte=2023-10-01T12:00:00Z"},"id":"schema_503"},"schema_504":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Updated at less than filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"updated_at_lt=2023-10-01T12:00:00Z"},"id":"schema_504"},"schema_505":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Updated at greater than filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"updated_at_gt=2023-10-01T12:00:00Z"},"id":"schema_505"},"schema_506":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Updated at less than or equal to filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"updated_at_lte=2023-10-01T12:00:00Z"},"id":"schema_506"},"schema_507":{"kind":"json-schema","data":{"type":"string","format":"date-time","description":"Updated at greater than or equal to filter. Datetime format must be in \"YY-MM-DDTHH:mm:ss.fffffffffZ\".","example":"updated_at_gte=2023-10-01T12:00:00Z"},"id":"schema_507"},"schema_508":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/RemoteViewerSessionsListForTenantResponse"}}}}}},"id":"schema_508"},"schema_509":{"kind":"json-schema","data":{"type":"integer","default":10,"maximum":1000},"id":"schema_509"},"schema_510":{"kind":"json-schema","data":{"type":"string","example":"start"},"id":"schema_510"},"schema_511":{"kind":"json-schema","data":{"type":"string","enum":["alias","created_at","last_seen","model","os_version","name","serial","provisioned_on","battery_level","dpc_version","eea_version","is_gms","security_state","wifi_ssid","platform","template_name","policy_name","state"]},"id":"schema_511"},"schema_512":{"kind":"json-schema","data":{"type":"string","enum":["BLUEPRINT","TEMPLATE"]},"id":"schema_512"},"schema_513":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"oneOf":[{"$ref":"#/components/schemas/OffsetPaginatedDeviceList"},{"$ref":"#/components/schemas/CursorPaginatedDeviceList"}]}}},"id":"schema_513"},"schema_514":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"oneOf":[{"$ref":"#/components/schemas/AppleDeviceV2"},{"$ref":"#/components/schemas/AndroidDeviceV2"},{"$ref":"#/components/schemas/LinuxDeviceV2"},{"$ref":"#/components/schemas/WindowsDeviceV2"}]}}},"id":"schema_514"},"schema_515":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","description":"response code","default":200},"message":{"type":"string","description":"response message"},"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/VPPLicense"}]}}}}}},"id":"schema_515"},"schema_516":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","description":"response code","default":200},"message":{"type":"string","description":"response message"},"content":{"$ref":"#/components/schemas/VPPLicense"}}},"id":"schema_516"},"schema_517":{"kind":"json-schema","data":{"type":"string","pattern":"^[a-zA-Z]{2}$","example":"us"},"id":"schema_517"},"schema_518":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/ItunesAppInfoV2"}]}}}}}},"id":"schema_518"},"schema_519":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"message":{"type":"string","example":"Preferred region updated successfully"}}}}},"id":"schema_519"},"schema_520":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/TenantAppUploadResponse"}}},"id":"schema_520"},"schema_521":{"kind":"json-schema","data":{"type":"number"},"id":"schema_521"},"schema_522":{"kind":"json-schema","data":{"type":"string","enum":["APPLE","WINDOWS"]},"id":"schema_522"},"schema_523":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TenantAppResponse"}]}}}}}},"id":"schema_523"},"schema_524":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/TenantAppResponse"}}},"id":"schema_524"},"schema_525":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TenantAppVersionResponse"}]}}}}}},"id":"schema_525"},"schema_526":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/TenantAppVersionDetailResponse"}}},"id":"schema_526"},"schema_527":{"kind":"json-schema","data":{"type":"object","properties":{"description":{"type":"string"}}},"id":"schema_527"},"schema_528":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/TenantAppVersionResponse"}}},"id":"schema_528"},"schema_529":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AppleAppStoreApp"}}}}}},"id":"schema_529"},"schema_530":{"kind":"json-schema","data":{"type":"string","enum":["name","created_at","updated_at"]},"id":"schema_530"},"schema_531":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/AppInfo"}]}}}}}},"id":"schema_531"},"schema_532":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/Webclip"}}},"id":"schema_532"},"schema_533":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Webclip"}]}}}}}},"id":"schema_533"},"schema_534":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/ProvisioningProfileUploadResponse"}}},"id":"schema_534"},"schema_535":{"kind":"json-schema","data":{"type":"number","description":"Maximum number of provisioning profiles to return","default":10},"id":"schema_535"},"schema_536":{"kind":"json-schema","data":{"type":"number","description":"Number of provisioning profiles to skip","default":0},"id":"schema_536"},"schema_537":{"kind":"json-schema","data":{"type":"string","description":"Filter by bundle identifier of the associated app"},"id":"schema_537"},"schema_538":{"kind":"json-schema","data":{"type":"string","description":"Filter by profile type","enum":["development","ad-hoc","app-store","enterprise"]},"id":"schema_538"},"schema_539":{"kind":"json-schema","data":{"type":"string","description":"Filter by Apple Developer Team identifier"},"id":"schema_539"},"schema_540":{"kind":"json-schema","data":{"type":"string","description":"Search in provisioning profile names and identifiers"},"id":"schema_540"},"schema_541":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of provisioning profiles"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningProfileWithDownloadResponse"}}}}}},"id":"schema_541"},"schema_542":{"kind":"json-schema","data":{"type":"string","format":"uuid","description":"Unique identifier for the provisioning profile"},"id":"schema_542"},"schema_543":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/ProvisioningProfileWithDownloadResponse"}}},"id":"schema_543"},"schema_544":{"kind":"json-schema","data":{"type":"number","description":"Maximum number of provisioning profile versions to return","default":10},"id":"schema_544"},"schema_545":{"kind":"json-schema","data":{"type":"number","description":"Number of provisioning profile versions to skip","default":0},"id":"schema_545"},"schema_546":{"kind":"json-schema","data":{"type":"string","description":"Search in provisioning profile version names"},"id":"schema_546"},"schema_547":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of provisioning profile versions"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ProvisioningProfileVersionWithDownloadResponse"}}}}}},"id":"schema_547"},"schema_548":{"kind":"json-schema","data":{"type":"string","format":"uuid","description":"Unique identifier for the specific version of the provisioning profile"},"id":"schema_548"},"schema_549":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/ProvisioningProfileVersionWithDownloadResponse"}}},"id":"schema_549"},"schema_550":{"kind":"json-schema","data":{"type":"string","format":"uuid","description":"Unique identifier for the specific version of the provisioning profile to delete"},"id":"schema_550"},"schema_551":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/TenantPreferredRegions"}}},"id":"schema_551"},"schema_552":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/EsperAppVersionResponse"}}},"id":"schema_552"},"schema_553":{"kind":"json-schema","data":{"type":"string","enum":["created_at (ascending)","-created_at (descending)","version_code (ascending)","-version_code (descending)"]},"id":"schema_553"},"schema_554":{"kind":"json-schema","data":{"type":"string","enum":["x86","x86_64","armeabi","arm64_v8a","armeabi_v7a","universal"]},"id":"schema_554"},"schema_555":{"kind":"json-schema","data":{"type":"string","description":"Filter by version code"},"id":"schema_555"},"schema_556":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer","description":"number of results returned"},"prev":{"type":"string","description":"URL for previous page of results"},"next":{"type":"string","description":"URL for next page of results"},"results":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/TenantEsperAppsItem"}]}}}}}},"id":"schema_556"},"schema_557":{"kind":"json-schema","data":{"type":"string","enum":["IMMEDIATE","WINDOW","RECURRING"]},"id":"schema_557"},"schema_558":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CommandRequest"}}}}}},"id":"schema_558"},"schema_559":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/CommandRequest"}}},"id":"schema_559"},"schema_560":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/CommandRequestStats"}}},"id":"schema_560"},"schema_561":{"kind":"json-schema","data":{"type":"string","enum":["Command Queued","Command Initiated","Command Acknowledged","Command In Progress","Command TimeOut","Command Success","Command Failure","Command Scheduled","Command Cancelled"]},"id":"schema_561"},"schema_562":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CommandStatus"}}}}}},"id":"schema_562"},"schema_563":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/CommandStatus"}}},"id":"schema_563"},"schema_564":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/CommandInbox"}}},"id":"schema_564"},"schema_565":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Converge"}}}}}},"id":"schema_565"},"schema_566":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/Converge"}}},"id":"schema_566"},"schema_567":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ConvergeCommand"}}}}}},"id":"schema_567"},"schema_568":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DEPSyncRequestForGetResponse"}}}}}},"id":"schema_568"},"schema_569":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/DEPSyncRequest"}}},"id":"schema_569"},"schema_570":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/DEPSyncRequestForGetResponse"}}},"id":"schema_570"},"schema_571":{"kind":"json-schema","data":{"type":"object","properties":{"csv_file":{"type":"string","format":"binary"}}},"id":"schema_571"},"schema_572":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SeamlessRequest"}}}}}},"id":"schema_572"},"schema_573":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/SeamlessRequest"}}},"id":"schema_573"},"schema_574":{"kind":"json-schema","data":{"type":"string","enum":["CSR_GENERATED","COMPLETED"]},"id":"schema_574"},"schema_575":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/APNSCertInfo"}}}}}},"id":"schema_575"},"schema_576":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_576"},"schema_577":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/APNSCertInfo"}}},"id":"schema_577"},"schema_578":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object"}}},"id":"schema_578"},"schema_579":{"kind":"json-schema","data":{"type":"string","properties":{"content":{"type":"string"}},"example":"-----BEGIN PUBLIC KEY----- MIGeMA0GCSqGSIb3DQEBAQUAA4GMADCBiAKBgE7FsxhVgAauNzV2S+B2O2TVpcKc /aPylhD8Abq0/5swcu3XFseP/GVttTH7JzSLLKdpyculA/DWfc73OP+r4LeswbAc pyvI8uDVCexU7YsND00Vs/L1i9RZXpCBk0oNECjIKQ6ex7ccI6VzZaTH6DallGkY eUcBApaAiL5QILTlAgMBAAE= -----END PUBLIC KEY-----"},"id":"schema_579"},"schema_580":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","example":"attachment; filename=\"Esper_Public_Key.pem\""}}},"id":"schema_580"},"schema_581":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string"},"prev":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DEP_Token_GET"}}}}}},"id":"schema_581"},"schema_582":{"kind":"json-schema","data":{"type":"string","format":"UUID"},"id":"schema_582"},"schema_583":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"content":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/DEP_Token_GET"}}}}},"id":"schema_583"},"schema_584":{"kind":"json-schema","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":".p7m file from abm console"},"token_name":{"type":"string"}},"required":["file","token_name"]},"id":"schema_584"},"schema_585":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","default":200},"message":{"type":"string"},"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VPPToken"}}}}}},"id":"schema_585"},"schema_586":{"kind":"json-schema","data":{"type":"object","properties":{"filename":{"type":"string","format":"binary"}}},"id":"schema_586"},"schema_587":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","default":201},"message":{"type":"string"},"content":{"$ref":"#/components/schemas/VPPToken"}}},"id":"schema_587"},"schema_588":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","description":"response code","default":204},"message":{"type":"string","description":"response message"},"content":{"type":"object"}}},"id":"schema_588"},"schema_589":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleEnterpriseDetails"}}}}}},"id":"schema_589"},"schema_590":{"kind":"json-schema","data":{"type":"object","properties":{"completion_token":{"type":"string"},"enterprise_token":{"type":"string"}},"required":["completion_token","enterprise_token"]},"id":"schema_590"},"schema_591":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"type":"object","properties":{"count":{"type":"integer"},"previous":{"type":"string"},"next":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/GoogleServiceAccountDetails"}}}}}},"id":"schema_591"},"schema_592":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","description":"returned response code"},"content":{"properties":{"count":{"type":"integer","description":"counter of number of builds retrieved"},"next":{"type":"string","format":"url","description":"url of the next ten builds"},"previous":{"type":"string","format":"url","description":"url of the previous ten builds"},"results":{"items":{"$ref":"#/components/schemas/Build_V1"}}}}}},"id":"schema_592"},"schema_593":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/Build_V1"}}},"id":"schema_593"},"schema_594":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Build_V1"}}},"id":"schema_594"},"schema_595":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","description":"returned response code"},"content":{"properties":{"count":{"type":"integer","description":"counter of number of device models retrieved"},"next":{"type":"string","format":"url","description":"url of the next ten device models"},"previous":{"type":"string","format":"url","description":"url of the previous ten device models"},"results":{"items":{"$ref":"#/components/schemas/Device_Model_V1"}}}}}},"id":"schema_595"},"schema_596":{"kind":"json-schema","data":{"type":"object","properties":{"content":{"properties":{"count":{"type":"integer","description":"counter of number of events retrieved"},"next":{"type":"string","format":"url","description":"url of the next ten events"},"previous":{"type":"string","format":"url","description":"url of the previous ten events"},"results":{"items":{"$ref":"#/components/schemas/Foundry_Event_V1"}}}}}},"id":"schema_596"},"schema_597":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/CreateReportResponse"},{"$ref":"#/components/schemas/GetReportResponsePreview"},{"$ref":"#/components/schemas/GetReportResponseDownload"}]},"id":"schema_597"}},"exampleStore":{"components/examples/example_devices":{"id":"components/examples/example_devices","value":{"operation_type":"CONVERGE","schedule_type":"IMMEDIATE","schedule_args":{"start_datetime":"2024-08-08T19:13:36.969Z","end_datetime":"2024-08-08T19:13:36.969Z","time_type":"console","window_start_time":"2024-08-08T19:00:00Z","window_end_time":"2024-08-08T20:00:00Z","days":[0]},"operation_device_query":{"device_ids":"460a4c28-b974-4c20-99b5-29aa6f10054f,560a4c28-b974-4c20-99b5-29aa6f10054e"},"arguments":{"converge_with_provision":true,"sample_key":"value"}},"summary":"An example where the query specifies a list of devices.","description":"An example where the query specifies a list of devices with specific values."},"components/examples/example_filters":{"id":"components/examples/example_filters","value":{"operation_type":"CONVERGE","schedule_type":"IMMEDIATE","schedule_args":{"start_datetime":"2024-08-08T19:13:36.969Z","end_datetime":"2024-08-08T19:13:36.969Z","time_type":"console","window_start_time":"2024-08-08T19:00:00Z","window_end_time":"2024-08-08T20:00:00Z","days":[0]},"operation_device_query":{"device_request":{"group_multi":"460a4c28-b974-4c20-99b5-29aa6f10054f,760a4c28-b974-4c20-99b5-29aa6f10054e","state":"1","filter1":"val1","filter2":"val2"}},"arguments":{"converge_with_provision":true,"sample_key":"value"}},"summary":"An example with devices filters."},"paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/devices":{"value":{"operation_type":"CONVERGE","schedule_type":"IMMEDIATE","schedule_args":{"start_datetime":"2024-08-08T19:13:36.969Z","end_datetime":"2024-08-08T19:13:36.969Z","time_type":"console","window_start_time":"2024-08-08T19:00:00Z","window_end_time":"2024-08-08T20:00:00Z","days":[0]},"operation_device_query":{"device_ids":"460a4c28-b974-4c20-99b5-29aa6f10054f,560a4c28-b974-4c20-99b5-29aa6f10054e"},"arguments":{"converge_with_provision":true,"sample_key":"value"}},"key":"devices","summary":"An example where the query specifies a list of devices.","description":"An example where the query specifies a list of devices with specific values.","id":"paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/devices"},"paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/filters":{"value":{"operation_type":"CONVERGE","schedule_type":"IMMEDIATE","schedule_args":{"start_datetime":"2024-08-08T19:13:36.969Z","end_datetime":"2024-08-08T19:13:36.969Z","time_type":"console","window_start_time":"2024-08-08T19:00:00Z","window_end_time":"2024-08-08T20:00:00Z","days":[0]},"operation_device_query":{"device_request":{"group_multi":"460a4c28-b974-4c20-99b5-29aa6f10054f,760a4c28-b974-4c20-99b5-29aa6f10054e","state":"1","filter1":"val1","filter2":"val2"}},"arguments":{"converge_with_provision":true,"sample_key":"value"}},"key":"filters","summary":"An example with devices filters.","id":"paths/~1v0~1operations~1/post/requestBody/content/application~1json/examples/filters"},"paths/~1v0~1operations~1{operationId}~1/put/requestBody/content/application~1json/examples/example-1":{"value":{"state":"CANCELLED","reason":"User requested"},"key":"example-1","summary":"Update status to CANCELLED","id":"paths/~1v0~1operations~1{operationId}~1/put/requestBody/content/application~1json/examples/example-1"},"paths/~1v0~1operations~1{operationId}~1/put/responses/200/content/application~1json/example":{"value":{"operationId":"12345","status":"SUCCEEDED"},"id":"paths/~1v0~1operations~1{operationId}~1/put/responses/200/content/application~1json/example"}},"securitySchemeStore":{"apiKey":{"id":"apiKey","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API KEY - Access Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access token for API is passed as authorization header in calls. You need to generate this from your Esper Console at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<domain>-api.esper.cloud"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in this Help article"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to generate an access token."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once you have the access token, you need to send an authorization header as below"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n"},"children":[]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note the use of keyword "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the token value."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can read more about api key authentication "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.esper.io/hc/en-us/articles/12656959508497"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"here"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"SCAPIAuthToken":{"id":"SCAPIAuthToken","type":"http","scheme":"bearer"},"AuthToken":{"id":"AuthToken","type":"apiKey","in":"header","paramName":"Authorization"},"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://{foo}-api.esper.cloud/api","variables":{"foo":{"default":"develop","description":"Custom end point"}}}],"logo":{"imageUrl":"esper-logo-white.svg","altText":"Logo","backgroundColor":"#141418"}},"options":{"hideReplay":false,"codeSamples":{"languages":[{"lang":"curl","label":"cURL"}]},"hideSidebar":true,"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"ESPER API REFERENCE","description":"# Introduction\nWelcome to Esper’s API documentation. The Esper API allows users to accomplish operations outside of the console. Some common uses for our APIs include observing device information and console activity, installing and updating apps, uploading files, and sending files to devices. Our users have also used the API to automate app updates, perform bulk actions, and more.\n\nEsper API endpoints use REST-based architecture and return JSON responses.\n\nSee our documentation for:\n\n* [Getting started guides](https://help.esper.io/hc/en-us/articles/14199291792145-Getting-Started-with-APIs)\n* [Commonly used API examples](https://help.esper.io/hc/en-us/articles/16036992814609-Commonly-Used-APIs)\n* [API command examples](https://help.esper.io/hc/en-us/articles/16693582666769-Scheduling-API-Commands)\n* [Automated Script examples](https://help.esper.io/hc/en-us/articles/22957898441745-Automating-App-Updates-Using-the-API)\n* [And more](https://help.esper.io/hc/en-us/sections/11388094627857-API)\n\n\n# Authentication\nYou need to create an API Key to interact with our APIs. Learn more about generating an API Key. You can also learn more about Esper and sign up for an account at esper.io/signup.\n\nSome endpoints also require an Enterprise ID. This ID can be found in the API Management section of the Esper console.\n# Pagination\nResponses may be paginated.\nUse the following parameters to query the data. A full list of parameters can be found on the endpoint’s documentation page.\n<table>\n  <thead>\n    <tr>\n      <th>Parameter</th>\n      <th>Data Type</th>\n      <th>Explanation</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n    <td>limit</td>\n    <td>integer</td>\n    <td>Limit the data returned. Default = 20.</td>\n  </tr>\n  <tr>\n    <td>offset</td>\n    <td>integer</td>\n    <td>Offset to the first item returned. Default = 0.</td>\n  </tr>\n  <tr>\n    <td>ordering</td>\n    <td>string</td>\n    <td>Order the results set by the field name. Varies by endpoint.</td>\n  </tr>\n  <tr>\n    <td>next</td>\n    <td>string</td>\n    <td>Paginate to the next response set.</td>\n  </tr>\n  <tr>\n    <td>previous</td>\n    <td>string</td>\n    <td>Paginate to the last set response.</td>\n  </tr>\n</table>\n\n# Errors\nWe use standard HTTP status codes for success or failure.\nA typical error response may look something like this:\n\n```json\n{\n  \"errors\": [],\n  \"message\": \"error message\",\n  \"status\": 400\n}\n```\n* `errors` -  List of error details\n* `message` - Error description\n* `status` - HTTP status code\n\nSome common status codes and messages are:\n\n<table>\n  <thead>\n    <tr>\n      <th>Number</th>\n      <th>Message</th>\n      <th>Explanation</th>\n    </tr>\n  </thead>\n  <tbody>\n    <tr>\n      <td>200</td>\n      <td>OK</td>\n      <td>The request succeeded.</td>\n    </tr>\n    <tr>\n      <td>201</td>\n      <td>Resource creation</td>\n      <td>A resource was created.</td>\n    </tr>\n    <tr>\n      <td>401</td>\n      <td>Unauthorized</td>\n      <td>The API key is invalid.</td>\n    </tr>\n    <tr>\n      <td>404</td>\n      <td>Not found</td>\n      <td>The resource was not found.</td>\n    </tr>\n    <tr>\n      <td>429</td>\n      <td>Rate limit exceeded</td>\n      <td>Too many requests. Wait a moment and try again.</td>\n    </tr>\n    <tr>\n      <td>500</td>\n      <td>Server error</td>\n      <td>Internal error. Wait a moment and try again. If the issue persists, <a target=\"_blank\" href=\"https://help.esper.io/hc/en-us/articles/14800200348561-Contacting-Esper-Support\">contact Esper.</a></td>\n    </tr>\n  </tbody>\n</table>\n\nSee how our systems are doing by checking our [status page](https://status.esper.cloud/).\n\n# Rate Limits\nTo ensure quality of service for all customers, we enforce rate limits for API requests. Most customers won’t hit this limit with normal use. In case you experience 429 or rate limit exceeded errors, we recommend the following:\n* Try sending requests in batches.\n* Begin with about 20 requests at a time and building up from there.\n* Ensure your scripts are efficient and don’t contain redundant calls.\n* Reach out to your account manager to discuss your options.\n"}},"baseSlug":"/openapi","routesMapping":{}}