Juniper Mist AI Orgs Psk Portals API

PSK Self-Service Portals are for1. **Wi-Fi users** who want to connect to a WLAN with personal PSK, they're told to connect to a URL where they can login (likely through company\u2019s SSO) and get the Wi-Fi Name / Passphrase - required input fields name, email so we can generate PSK2. **PSK Admins** (they don't have access to normal Network Admin Portal)When a PSK portal is created, an unique URL will be generated (e.g. https://psk.mist.com/xxxxxx)

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 11 operations across 7 paths, and defines 31 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.

11 operations 7 paths 31 schemas 2 DELETE5 GET2 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

Contact

Thomas Munzer

License

MIT

Resource Areas

Authentication & Security 3

Juniper Mist AI Orgs Psk Portals 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 11

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

Orgs Psk Portals 11

PSK Self-Service Portals are for 1. Wi-Fi users who want to connect to a WLAN with personal PSK, they're told to connect to a URL where they can login (likely through company\u201…

GET

/api/v1/orgs/{org_id}/pskportals

listOrgPskPortals

listOrgPskPortals 3 params → 200400401403404429

POST

/api/v1/orgs/{org_id}/pskportals

createOrgPskPortal

createOrgPskPortal 1 param body → 200400401403404429

GET

/api/v1/orgs/{org_id}/pskportals/logs

listOrgPskPortalLogs

listOrgPskPortalLogs 6 params → 200400401403404429

GET

/api/v1/orgs/{org_id}/pskportals/logs/count

countOrgPskPortalLogs

countOrgPskPortalLogs 6 params → 200400401403404429

GET

/api/v1/orgs/{org_id}/pskportals/logs/search

searchOrgPskPortalLogs

searchOrgPskPortalLogs 14 params → 200400401403404429

DELETE

/api/v1/orgs/{org_id}/pskportals/{pskportal_id}

deleteOrgPskPortal

deleteOrgPskPortal 2 params → 200400401403404429

GET

/api/v1/orgs/{org_id}/pskportals/{pskportal_id}

getOrgPskPortal

getOrgPskPortal 2 params → 200400401403404429

PUT

/api/v1/orgs/{org_id}/pskportals/{pskportal_id}

updateOrgPskPortal

updateOrgPskPortal 2 params body → 200400401403404429

DELETE

/api/v1/orgs/{org_id}/pskportals/{pskportal_id}/portal_image

deleteOrgPskPortalImage

deleteOrgPskPortalImage 2 params → 200400401403404429

POST

/api/v1/orgs/{org_id}/pskportals/{pskportal_id}/portal_image

uploadOrgPskPortalImage

uploadOrgPskPortalImage 2 params body → 200400401403404429

PUT

/api/v1/orgs/{org_id}/pskportals/{pskportal_id}/portal_template

updateOrgPskPortalTemplate

updateOrgPskPortalTemplate 2 params body → 200400401403404429

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are psk_portal (25 properties), psk_portal_template_setting (10 properties), psk_portal_sso (8 properties), response_psk_portal_logs_search_item (8 properties). Each schema is shown below with its type and property counts.

string

Unique ID of the object instance in the Mist Organization

response_count

object

6 properties 6 required

psk_portal_template_setting

object

10 properties

psk_portal_sso_idp_sign_algo

string

Signing algorithm for SAML Assertion. enum: sha1, sha256, sha384, sha512. enum: sha1, sha256, sha384, sha512

response_psk_portal_logs_search

object

6 properties

psk_portal_template

object

1 property

org_psk_portal_logs_count_distinct

string

enum: adminid, adminname, pskid, pskname, pskportalid, userid

psk_portal_image

object

2 properties

response_http403

object

1 property

portal_template_alignment

string

defines alignment on portal. enum: center, left, right

count_results

array

count_result

object

1 property 1 required

response_psk_portal_logs_search_item_list

array

response_http404

object

1 property

timestamp

number

Epoch (seconds)

psk_portal_list

array

response_psk_portal_logs_search_item

object

8 properties

vlan_id_with_variable

response_http400

object

1 property

psk_portal_type

string

for personal psk portal. enum: admin, byod

response_http429

object

1 property

psk_portal_passphrase_rules

object

7 properties

psk_portal_required_fields

array

what information to ask for (email is required by default)

psk_portal_sso_allowed_roles

array

Allowed roles for accessing psk portal, if none, any role is permitted

response_http401

object

1 property

org_id

string

psk_portal

object

25 properties 2 required

psk_portal_auth

string

enum: sponsor, sso

modified_time

number

When the object has been modified for the last time, in epoch

psk_portal_sso

object

If auth==sso

8 properties

created_time

number

When the object has been created, in epoch

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Juniper Mist AI publishes across the network.

Juniper Mist WebSocket Streaming API

AE Profile APIs.io

Juniper Mist Webhooks API

AE Profile APIs.io

Juniper Mist AI Admins API

AE Profile APIs.io

Juniper Mist AI Admins Login API

AE Profile APIs.io

Juniper Mist AI Admins Login - OAuth2 API

AE Profile APIs.io

Juniper Mist AI Admins Logout API

AE Profile APIs.io

Juniper Mist AI Admins Lookup API

AE Profile APIs.io

Juniper Mist AI Admins Recover Password API

AE Profile APIs.io

Juniper Mist AI Constants Definitions API

AE Profile APIs.io

Juniper Mist AI Constants Events API

AE Profile APIs.io

Juniper Mist AI Constants Models API

AE Profile APIs.io

Juniper Mist AI Installer API

AE Profile APIs.io

#Orgs Psk Portals

← Back to J APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Juniper Mist AI Orgs Psk Portals API

Metadata

Authentication & Security 3

Paths & Operations 11

Schemas 31

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Juniper Mist AI Orgs Psk Portals API

Metadata

Authentication & Security 3

Paths & Operations 11

Schemas 31

Specification

Source

More from Juniper Mist AI 12

API Details

Provider

Explore more