How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mist 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)

Mist Orgs Psk Portals API is one of 212 APIs that Mist 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.

This API exposes 11 operations across 7 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 2606.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.2.0
API Version
2606.1.1
Base URL
https://api.mist.com/api/v1
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Mist Orgs Psk Portals API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiToken). An API key is passed in the header as X-CSRFToken (csrfToken). By default, every request must be authenticated.

  • apiToken — Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…
  • csrfToken — Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…

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), response_psk_portal_logs_search_item (8 properties), psk_portal_sso (8 properties). Each schema is shown below with its type and property counts.

response_http403
object
Standard HTTP 403 permission error response
1 property
org_id
string
Unique identifier of a Mist organization
response_http400
object
Standard HTTP 400 bad request error response
1 property
psk_portal_sso
object
Single sign-on settings used when auth==sso
8 properties
response_count
object
Distinct count response for time-bounded search results
6 properties 6 required
portal_template_alignment
string
defines alignment on portal. enum: center, left, right
psk_portal_sso_idp_sign_algo
string
Signing algorithm for SAML Assertion. enum: sha1, sha256, sha384, sha512. enum: sha1, sha256, sha384, sha512
psk_portal_required_fields
array
User information fields requested by the portal; email is required by default
vlan_id_with_variable
VLAN ID, either numeric or expressed as a template variable string
count_results
array
List of count result rows
timestamp
number
Epoch timestamp, in seconds
psk_portal_template_setting
object
Custom UI settings for the PSK portal template
10 properties
modified_time
number
When the object has been modified for the last time, in epoch
count_result
object
Count result row with the matching distinct field values
1 property 1 required
psk_portal_auth
string
Portal access method for guest authentication, either sponsor or sso. enum: sponsor, sso
psk_portal_list
array
List of PSK portal configurations
psk_portal_passphrase_rules
object
Passphrase generation rules for PSKs created through a portal
7 properties
psk_portal_type
string
for personal psk portal. enum: admin, byod
response_psk_portal_logs_search_item_list
array
PSK Portal log entries returned by search
response_http404
object
Standard HTTP 404 not found error response
1 property
response_http401
object
Standard HTTP 401 authentication error response
1 property
response_http429
object
Standard HTTP 429 rate limit error response
1 property
psk_portal_image
object
PSK portal image upload payload
2 properties
id
string
Unique ID of the object instance in the Mist Organization
psk_portal_template
object
Portal UI customization payload
1 property
created_time
number
When the object has been created, in epoch
response_psk_portal_logs_search
object
Paginated response for organization PSK Portal log search results
6 properties
psk_portal
object
Self-service portal configuration for issuing personal PSKs
25 properties 2 required
org_psk_portal_logs_count_distinct
string
enum: adminid, adminname, pskid, pskname, pskportalid, userid
response_psk_portal_logs_search_item
object
PSK Portal log entry returned by organization log search
8 properties
psk_portal_sso_allowed_roles
array
SSO roles allowed to access the PSK portal; if empty, any role is permitted

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mist-orgs-psk-portals-api-openapi.yml Raw ↑

Other APIs Mist publishes across the network.

Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
Where this information came from

This is an independent, third-party profile of Mist Orgs Psk Portals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.