Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsNAC Portals

createOrgNacPortal

POST
/api/v1/orgs/{org_id}/nacportals

Create a NAC portal configuration for guest access, guest administration, or Marvis Client certificate onboarding.

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

Request Body

application/json

NAC portal configuration for 802.1X onboarding, guest access, or Marvis client certificate provisioning

access_type?nac_portal_access_type

If type==marvis_client, whether onboarding applies to wireless clients or both wireless and wired clients. enum: wireless, wireless+wired.

Default"wireless"

Value in

  • "wireless"
  • "wireless+wired"
additional_cacerts?array<string>

Additional CA certificates trusted during NAC portal certificate onboarding

additional_nac_server_name?array<string>

Optional list of additional NAC server names

bg_image_url?string

URL of the NAC portal background image

cert_expire_time?integer

Validity duration for portal-issued client certificates, in days

eap_type?nac_portal_eap_type

EAP mode used when onboarding wireless clients through the NAC portal. enum: wpa2, wpa3.

Default"wpa2"

Value in

  • "wpa2"
  • "wpa3"
enable_location?boolean

Whether location data collection is enabled for devices onboarding through this NAC portal

Defaultfalse
enable_telemetry?boolean

Optional, model, version, fingerprinting, events (connecting, disconnect, roaming), which ap, default is false

expiry_notification_time?integer

Number of days before certificate expiration to start sending reminder notifications

name?string

Human-readable name of the NAC portal

notify_expiry?boolean

Whether to send reminder notifications before portal-issued certificates expire

portal?

Guest portal settings used when type==guest_portal

ssid?string

Wireless SSID associated with the NAC portal

sso?

SAML SSO settings for NAC portal authentication and role mapping

template_url?string

URL for the NAC portal template customization resource

tos?string

Terms of service text shown in the NAC portal

type?nac_portal_type

NAC portal mode, such as guest admin, guest portal, or Marvis client onboarding. enum: guest_admin, guest_portal, marvis_client.

Value in

  • "guest_admin"
  • "guest_portal"
  • "marvis_client"

Response Body

curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/nacportals" \  -H "Content-Type: application/json" \  -d '{}'
{  "access_type": "wireless",  "cert_expire_time": 365,  "enable_location": false,  "enable_telemetry": true,  "expiry_notification_time": 2,  "name": "get-wifi",  "notify_expiry": true,  "ssid": "Corp",  "sso": {    "idp_cert": "-----BEGIN CERTIFICATE-----\nMIIFZjCCA06gAwIBAgIIP61/1qm/uDowDQYJKoZIhvcNAQELBQE\n-----END CERTIFICATE-----",    "idp_sign_algo": "sha256",    "idp_sso_url": "https://yourorg.onelogin.com/trust/saml2/http-post/sso/138130",    "issuer": "https://app.onelogin.com/saml/metadata/138130",    "nameid_format": "email",    "sso_role_matching": [      {        "assigned": "user",        "match": "Student"      }    ],    "use_sso_role_for_cert": true  }}

listOrgNacPortals GET

List NAC portal configurations in the organization for guest portal, guest admin, or Marvis Client onboarding workflows.

getOrgNacPortal GET

Retrieve configuration details for a specific NAC portal, including portal type, SSID, SSO, guest portal, certificate, and template settings.