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 MSPs SSO API

MSP SSO, or Single Sign-On, is a method of authentication that allows users to securely log in to multiple applications and websites with a single set of login credentials.It involves integrating the MSP portal with an Identity Provider (IdP) using the Security Assertion Markup Language (SAML) framework.This enables users to authenticate themselves through their corporate IdP, eliminating the need to remember separate passwords or enter credentials each time they access the MSP portal.

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

This API exposes 9 operations across 6 paths, and defines 38 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.

9 operations 6 paths 38 schemas 1 DELETE5 GET2 POST1 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 MSPs SSO 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 9

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

MSPs SSO 9

MSP SSO, or Single Sign-On, is a method of authentication that allows users to securely log in to multiple applications and websites with a single set of login credentials. It inv…

GET
/api/v1/msps/{msp_id}/ssos
listMspSsos
listMspSsos 1 param → 200400401403404429
POST
/api/v1/msps/{msp_id}/ssos
createMspSso
createMspSso 1 param body → 200400401403404429
DELETE
/api/v1/msps/{msp_id}/ssos/{sso_id}
deleteMspSso
deleteMspSso 2 params → 200400401403404429
GET
/api/v1/msps/{msp_id}/ssos/{sso_id}
getMspSso
getMspSso 2 params → 200400401403404429
PUT
/api/v1/msps/{msp_id}/ssos/{sso_id}
updateMspSso
updateMspSso 2 params body → 200400401403404429
POST
/api/v1/msps/{msp_id}/ssos/{sso_id}/delete_admins
deleteMspSsoAdmins
deleteMspSsoAdmins 2 params body → 200400401403404429
GET
/api/v1/msps/{msp_id}/ssos/{sso_id}/failures
listMspSsoLatestFailures
listMspSsoLatestFailures 2 params → 200400401403404429
GET
/api/v1/msps/{msp_id}/ssos/{sso_id}/metadata
getMspSamlMetadata
getMspSamlMetadata 2 params → 200400401403404429
GET
/api/v1/msps/{msp_id}/ssos/{sso_id}/metadata.xml
downloadMspSamlMetadata
downloadMspSamlMetadata 2 params → 200400401403404429

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are sso (46 properties), sso_mxedge_proxy (6 properties), sso_mxedge_proxy_auth_server (6 properties), saml_metadata (5 properties). Each schema is shown below with its type and property counts.

sso_oauth_type
string
if idptype==oauth. enum: azure, azure-gov, okta, pingidentity
id
string
Unique ID of the object instance in the Mist Organization
sso_mxedge_proxy_auth_server
object
6 properties
response_sso_failure_search
object
1 property 1 required
sso_mxedge_proxy_ssids
array
SSIDs that support eduroam
response_http403
object
1 property
sso_ldap_type
string
if idptype==ldap. enum: azure, custom, google, okta, pingidentity
sso_openroaming
object
if idptype==openroaming
2 properties 1 required
sso_mxedge_proxy_acct_servers
array
oauth_provider_domain
string
If oauthtype==okta, specifies the region-specific OAuth provider domain. enum: okta.com, oktapreview.com, okta-emea.com, okta-gov.com, okta.mil, mtls.okta.com
sso_idp_type
string
SSO IDP Type: For Admin SSO, enum: saml For NAC SSO, enum: ldap, mxedgeproxy, oauth, openroaming
saml_metadata
object
5 properties
oauth_ping_identity_region
string
enum: us (United States, default), ca (Canada), eu (Europe), asia (Asia), au (Australia)
response_sso_failure_search_results
array
site_id
string
sso_idp_sign_algo
string
Required if idptype==saml, Signing algorithm for SAML Assertion. enum: sha1, sha256, sha384, sha512
response_http404
object
1 property
sso_delete_admins_response
object
2 properties
timestamp
number
Epoch (seconds)
response_sso_failure_search_item
object
3 properties 3 required
sso
object
SSO
46 properties 1 required
sso_openroaming_ssids
array
SSIDs that support OpenRoaming
response_http400
object
1 property
sso_mxedge_proxy_proxy_hosts
array
Public hostname/IPs
ssos
array
sso_mxedge_proxy_acct_server
object
3 properties
sso_nameid_format
string
if idptype==saml. enum: email, unspecified
response_http429
object
1 property
sso_mxedge_proxy
object
If idptype==mxedgeproxy, this requires mistnac to be enabled on the mxcluster
6 properties
msp_id
string
sso_delete_admins
object
1 property 1 required
sso_ldap_ca_certs
array
Required if idptype==ldap, list of CA certificates to validate the LDAP certificate
response_http401
object
1 property
org_id
string
sso_mxedge_proxy_auth_servers
array
sso_ldap_server_hosts
array
If idptype==ldap, list of LDAP/LDAPS server IP Addresses or Hostnames
modified_time
number
When the object has been modified for the last time, in epoch
created_time
number
When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-ai-msps-sso-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