Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Juniper Mist AI Orgs Guests API

Guests are users who are accessing the wi-fi network as a temporary or non-permanent visitor.

Juniper Mist AI Orgs Guests API is one of 211 APIs that Juniper Mist AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orgs Guests. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 2604.1.1.

Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.

6 operations 4 paths 14 schemas 1 DELETE4 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2604.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

Juniper Mist AI Orgs Guests API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equa…
  • basicAuth — While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
  • csrfToken — This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-siterequestforgery), all the POST / PUT / DELETE APIs needs…

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 4 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs Guests 6

Guests are users who are accessing the wi-fi network as a temporary or non-permanent visitor.

GET
/api/v1/orgs/{org_id}/guests
listOrgGuestAuthorizations
listOrgGuestAuthorizations 1 param → 200400401403404429
GET
/api/v1/orgs/{org_id}/guests/count
countOrgGuestAuthorizations
countOrgGuestAuthorizations 6 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/guests/search
searchOrgGuestAuthorization
searchOrgGuestAuthorization 9 params → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/guests/{guest_mac}
deleteOrgGuestAuthorization
deleteOrgGuestAuthorization 2 params → 200400401403404429
GET
/api/v1/orgs/{org_id}/guests/{guest_mac}
getOrgGuestAuthorization
getOrgGuestAuthorization 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/guests/{guest_mac}
updateOrgGuestAuthorization
updateOrgGuestAuthorization 2 params body → 200400401403404429

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are guest_org (20 properties), guest (18 properties), response_guest_search (6 properties), response_count (6 properties). Each schema is shown below with its type and property counts.

response_count
object
6 properties 6 required
response_guest_search
object
6 properties 5 required
guest_org
object
Guest
20 properties 1 required
response_http403
object
1 property
count_results
array
guests
array
count_result
object
1 property 1 required
response_http404
object
1 property
response_http400
object
1 property
guest
object
Guest
18 properties
response_http429
object
1 property
org_guests_count_distinct
string
enum: authmethod, company, ssid
response_guest_search_results
array
response_http401
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-orgs-guests-api-openapi.yml Raw ↑

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API
Juniper Mist Webhooks API
Juniper Mist AI Admins API
Juniper Mist AI Admins Login API
Juniper Mist AI Admins Login - OAuth2 API
Juniper Mist AI Admins Logout API
Juniper Mist AI Admins Lookup API
Juniper Mist AI Admins Recover Password API
Juniper Mist AI Constants Definitions API
Juniper Mist AI Constants Events API
Juniper Mist AI Constants Models API
Juniper Mist AI Installer API