Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsPsk Portals

getOrgPskPortal

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

Retrieve PSK Portal configuration details, including SSID, mode, authentication, SSO, passphrase, expiry, notification, and template URLs.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid
pskportal_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/pskportals/000000ab-00ab-00ab-00ab-0000000000ab"
{  "auth": "sso",  "created_time": 1727272316,  "expire_time": 262800,  "expiry_notification_time": 2,  "hide_psks_created_by_other_admins": false,  "id": "86ef73e5-e360-4e33-abd8-c2da7b11cbd6",  "max_usage": 1,  "modified_time": 1727272316,  "name": "USR-test",  "notify_expiry": false,  "org_id": "8f6c24d5-b618-4c30-b6ff-b2febc1078ab",  "passphrase_rules": {    "alphabets_enabled": true,    "length": 8,    "numerics_enabled": true,    "symbols": "()[]{}_%@#&$",    "symbols_enabled": true  },  "role": "",  "ssid": "USR-test",  "sso": {    "idp_cert": "-----BEGIN CERTIFICATE-----\nMIIDqDCCApCgA...-----END CERTIFICATE-----",    "idp_sign_algo": "sha256",    "idp_sso_url": "https://dev-00000000.okta.com/app/dev-00000000/a6b88bec5ab7/sso/saml",    "issuer": "http://www.okta.com/a6b88bec5ab7",    "nameid_format": "email"  },  "type": "byod",  "ui_url": "https://pskportal.gc1.mist.com/#!byod/a6b88bec-5ab7-41ae-a34c-44ff52a8b81d",  "vlan_id": 123}

createOrgPskPortal POST

Create a self-service PSK Portal configuration for issuing personal PSKs, including SSID, BYOD or admin mode, SSO or sponsor authentication, passphrase rules, and expiry settings.

deleteOrgPskPortal DELETE

Delete a PSK Portal configuration by portal ID, removing the self-service entry point for issuing PSKs through that portal.