swagger: '2.0' info: description: "# Introduction\nEsper APIs are a set of REST-based APIs that help you programmatically control and monitor Android-based Dedicated Devices running the Esper agent using Esper Manage. With these APIs, you can orchestrate and manage devices that have been provisioned against your Esper Manage environment. Furthermore, these APIs allows you to manage the Android applications installed on your Dedicated Device fleet. To read more about the various capabilities of Esper APIs and Esper managed devices, please visit [esper.io](https://esper.io). This guide describes all the available APIs in detail, along with code samples for you to quickly ramp up to using them.\\\nTo use these APIs you will need to create a developer account with Esper and get access to the Esper Dev Console and the Esper ManageDashboard. You can find out more about Esper and sign up for free at [esper.io/signup](https://esper.io/signup)\\\nWe've done our best to keep this document up to date, but if you find any issues, please reach out to us at developer@esper.io.\n\n# SDK\n\n You are welcome to use your favorite HTTP/REST library for your programming language in order to call these APIs, or you can use our SDK (currently supporting [python](https://github.com/esper-io/esper-client-py)) to do so.\n\n\n# Authentication\nThe client needs to send authentication details to access the Esper APIs by generating and applying an API key. Be sure to sign up for your free trial account with Esper Dev to generate your key:\n\n# Errors\nThe APIs use standard HTTP status codes to indicate success or failure. All error responses will have a JSON body in the following format:\n\n```\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" version: 1.0.0 title: ESPER API REFERENCE Application Enterprise API termsOfService: https://esper.io/terms-of-service contact: email: developer@esper.io license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html host: foo-api.esper.cloud basePath: /api schemes: - https tags: - name: Enterprise description: The Esper Enterprise APIs to manage the account information set up for your company’s account. Read our Esper Manage documentation or use the Esper Manage Dashboard through the Esper Developer Console externalDocs: description: Find out more about enterprise settings url: https://docs.esper.io/home/console.html#company-settings paths: /v1/enterprise/{enterprise_id}/: parameters: - name: enterprise_id in: path description: A UUID string identifying this enterprise. required: true type: string format: uuid get: operationId: getEnterprise summary: Get your enterprise information description: Returns Enterprise instance produces: - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/EnterpriseV1' security: - apiKey: [] tags: - Enterprise patch: operationId: partialUpdateEnterprise summary: Partial update enterprise information description: Returns updated enterprise produces: - application/json parameters: - name: data in: body required: true schema: $ref: '#/definitions/EnterpriseUpdateV1' responses: '200': description: successful operation schema: $ref: '#/definitions/EnterpriseV1' security: - apiKey: [] tags: - Enterprise definitions: EnterpriseV1: required: - id - name - short_code type: object properties: id: title: Id description: Id of the enterprise type: string format: uuid readOnly: true name: title: Name description: Name of the enterprise type: string maxLength: 255 minLength: 1 short_code: title: Short code 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. type: string maxLength: 10 minLength: 1 readOnly: true registered_name: title: Registered name of the enterprise description: Registered Name of the enterprise type: string maxLength: 255 minLength: 1 registered_address: title: Registered address description: Registered address of the enterprise. type: string maxLength: 255 minLength: 1 location: title: Enterprise location description: City, State, Country location of the enterprise type: string maxLength: 255 minLength: 1 zipcode: title: Enterprise zipcode description: Zip code of enterprise location type: string maxLength: 8 minLength: 1 contact_person: title: Contact person description: Person who is the point of contact for the enterprise type: string maxLength: 255 minLength: 1 x-nullable: true contact_number: title: Contact number description: Contact number of the enterprise type: string maxLength: 20 minLength: 1 x-nullable: true contact_email: title: Contact email description: Contact email address of the enterprise type: string format: email maxLength: 254 minLength: 1 emm: title: Google EMM description: This field will have details about emm enrollment if the enterprise is emm enrolled type: object properties: google_enterprise_id: type: string maxLength: 50 minLength: 1 x-nullable: true readOnly: true created_on: title: Created on description: Date and time of when this resource was created type: string format: date-time readOnly: true updated_on: title: Updated on description: Date and time of when this resource was updated type: string format: date-time readOnly: true EnterpriseUpdateV1: type: object properties: id: title: Id description: Id of the enterprise type: string format: uuid readOnly: true name: title: Enterprise Name description: Name of the enterprise type: string maxLength: 255 minLength: 1 registered_name: title: Registered name description: Registered Name of the enterprise type: string maxLength: 255 minLength: 1 registered_address: title: Registered address description: Registered address of the enterprise. type: string maxLength: 255 minLength: 1 location: title: Enterprise location description: City, State, Country location of the enterprise type: string maxLength: 255 minLength: 1 zipcode: title: Enterprise zipcode description: Description of the enterprise type: string maxLength: 8 minLength: 1 contact_person: title: Contact person description: Person who is the point of contact for the enterprise type: string maxLength: 255 minLength: 1 x-nullable: true contact_number: title: Contact number description: Contact number of the enterprise type: string maxLength: 20 minLength: 1 x-nullable: true contact_email: title: Contact email description: Contact email address of the enterprise type: string format: email maxLength: 254 minLength: 1 securityDefinitions: apiKey: description: "#### API KEY - Access Token\nAccess token for APIs passed as authorization header in calls. You need to generate this from your Esper Dev Console at `-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper Dev account. Please follow the instructions [here](https://docs.esper.io/home/module/genapikey.html) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n curl -X GET \\\n https://-api.esper.cloud/api/enterprise//device/ \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication scheme [here](https://console-docs.esper.io/API/generate.html).\n" name: Authorization type: apiKey in: header x-tagGroups: - name: API Reference tags: - Enterprise - Application - Application V1 - Device - Device Group - Commands - Group Commands - Token - Commands V2 - Enterprise Policy - Geofence - Reports - Subscription - Content