Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsPsk Portals

listOrgPskPortals

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

List self-service PSK Portal configurations in the organization, including portal mode, SSID, authentication, expiry, and passphrase rules.

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

Query Parameters

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/pskportals"
[  {    "auth": "sponsor",    "bg_image_url": "string",    "cleanup_psk": false,    "created_time": 0.1,    "expire_time": 0,    "expiry_notification_time": 0,    "hide_psks_created_by_other_admins": false,    "id": "53f10664-3ce8-4c27-b382-0ef66432349f",    "max_usage": 0,    "modified_time": 0.1,    "name": "string",    "notification_renew_url": "https://custom-sso/url",    "notify_expiry": true,    "notify_on_create_or_edit": false,    "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61",    "passphrase_rules": {      "alphabets_enabled": true,      "length": 8,      "max_length": 8,      "min_length": 8,      "numerics_enabled": true,      "symbols": "()[]{}_%@#&$",      "symbols_enabled": true    },    "required_fields": [      "string"    ],    "role": "string",    "ssid": "string",    "sso": {      "allowed_roles": [        "string"      ],      "idp_cert": "string",      "idp_sign_algo": "sha1",      "idp_sso_url": "string",      "issuer": "string",      "nameid_format": "string",      "role_mapping": {        "property1": "string",        "property2": "string"      },      "use_sso_role_for_psk_role": true    },    "template_url": "string",    "thumbnail_url": "string",    "type": "admin",    "ui_url": "string",    "vlan_id": "string"  }]

countOrgPskPortalLogs GET

Count PSK Portal log entries across the organization, optionally grouped by `distinct` and filtered by time range.

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.