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 Admins API

An org admin, or organization administrator, is a user with administrative privileges within a specific organization. They have the authority to manage and oversee the operations and settings of that organization's portal. The different types of access levels for an org admin include: * Super User: This role has full access to the MSP portal and all tenant organizations. A super usercan manage other administrators and has the highest level of privileges. * Network Admin: A network admin has limited access to the MSP portal. They can be granted accessto all organizations or specific organizations, with access to limited features in the organizations' portals. They are responsible for monitoring, verifying, and troubleshooting the network within their assigned organizations. * Observer: An observer has view-only access to limited features in the MSP portal. They can be grantedaccess to all organizations or specific organizations, with view-only access to limited features in the organizations' portals. Observers monitor events in the network and bring any issues to the attention of the network administrator for resolution. * Installer: An installer can be granted access to all organizations or specific organizations, withonly the ability to install access points for these organizations. They are responsible for setting up and installing access points in the network. * Helpdesk: A helpdesk user can be granted access to all organizations or specific organizations,with only helpdesk monitoring and workflow capabilities for these organizations. They assist with monitoring and resolving issues reported by users within the organization. These different access levels allow org admins to perform their specific roles and responsibilitieswithin the MSP portal while ensuring appropriate access and security measures are in place.

Juniper Mist AI Orgs Admins 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 Admins. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 23 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 23 schemas 2 DELETE1 GET1 POST2 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 Admins 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 — 2 DELETE, 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Orgs Admins 6

An org admin, or organization administrator, is a user with administrative privileges within a specific organization. They have the authority to manage and oversee the operations…

GET
/api/v1/orgs/{org_id}/admins
listOrgAdmins
listOrgAdmins 1 param → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/admins/{admin_id}
revokeOrgAdmin
revokeOrgAdmin 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/admins/{admin_id}
updateOrgAdmin
updateOrgAdmin 2 params body → 200400401403404429
POST
/api/v1/orgs/{org_id}/invites
inviteOrgAdmin
inviteOrgAdmin 1 param body → 200400401403404429
DELETE
/api/v1/orgs/{org_id}/invites/{invite_id}
uninviteOrgAdmin
uninviteOrgAdmin 2 params → 200400401403404429
PUT
/api/v1/orgs/{org_id}/invites/{invite_id}
updateOrgAdminInvite
updateOrgAdminInvite 2 params body → 200400401403404429

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are admin (19 properties), admin_privilege (13 properties), response_http429 (1 property), response_http400 (1 property). Each schema is shown below with its type and property counts.

admin_privilege
object
Privilieges settings
13 properties 2 required
admin_privilege_scope
string
enum: msp, org, orggroup, site, sitegroup
admin_privilege_views
array
Custom roles restrict Org users to specific UI views. This is useful for limiting UI access of Org users. Custom roles restrict Org users to specific UI views.…
response_http403
object
1 property
admin_privilege_sitegroup_ids
array
admin
object
19 properties
admin_privilege_orggroup_ids
array
If scope==orggroup
response_http404
object
1 property
admin_tags
array
admin_privilege_msp_id
string
Required if scope==msp
admins
array
admin_privilege_role
string
access permissions. enum: admin, helpdesk, installer, read, write
response_http400
object
1 property
response_http429
object
1 property
admin_privilege_view
string
admin_privilege_org_id
string
Required if scope==org
admin_privilege_site_id
string
Required if scope==site
sitegroup_id
string
admin_compliance_status
string
trade compliance status. enum: blocked, restricted
response_http401
object
1 property
admin_privileges
array
List of privileges the admin has
orggroup_id
string
admin_id
string
ID of the administrator

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-orgs-admins-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