updateOrgPskPortal
Update a PSK Portal configuration, including SSID, mode, authentication, SSO, passphrase, expiry, notification, and template settings.
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
uuiduuidRequest Body
application/json
Self-service portal configuration for issuing personal PSKs
Portal access method, enum: sponsor, sso
"sso"Value in
- "sponsor"
- "sso"
URL of the background image used by the PSK portal
Whether to clean up existing PSKs when the portal is deleted or its SSID changes
falsePSK lifetime, in minutes, for keys created through this portal
Number of days before PSK expiration to start sending reminder notifications
Only if type==admin, hide PSKs created by other PSK admins
falseMaximum concurrent clients for each PSK created through this portal; 0 means unlimited
0 <= value0Display name of the PSK portal
Optional renewal URL included in notification emails. Use a custom URL, a Mist-generated URL, or a shortened URL pointing to either
urlWhether to send reminder notifications before PSKs created through this portal expire
Whether to send notifications when a PSK is created or edited through this portal
falseGeneration rules for PSK passphrases created through this portal
User information fields requested by the portal when generating a PSK
Client role assigned to PSKs created through this portal
WLAN SSID for PSKs created through this portal
Single sign-on configuration used when auth==sso
URL of the UI customization template for this portal
URL of the thumbnail image used by the PSK portal
Portal mode for personal PSK onboarding, either admin or BYOD
Value in
- "admin"
- "byod"
Public URL where users access the PSK portal
VLAN ID returned for clients using PSKs from this portal
Response Body
curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/pskportals/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "auth": "sso", "expire_time": 262800, "expiry_notification_time": 2, "hide_psks_created_by_other_admins": false, "max_usage": 1, "name": "USR-test", "notify_expiry": false, "passphrase_rules": { "alphabets_enabled": true, "length": 8, "numerics_enabled": true, "symbols": "()[]{}_%@#&$", "symbols_enabled": true }, "sponsors": { "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" }, "ssid": "USR-test", "type": "byod", "vlan_id": "nu42ll" }'{ "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}