openapi: 3.2.0 info: title: Mist Orgs NAC Rules API description: '> Version: **2607.1.1** > > Date: **August 17, 2026** NOTE: Some important API changes will be introduced.' contact: name: Thomas Munzer email: tmunzer@juniper.net version: 2607.1.1 servers: - url: https://api.mist.com variables: {} - url: https://api.gc1.mist.com variables: {} - url: https://api.ac2.mist.com variables: {} - url: https://api.gc2.mist.com variables: {} - url: https://api.gc4.mist.com variables: {} - url: https://api.eu.mist.com variables: {} - url: https://api.gc3.mist.com variables: {} - url: https://api.ac6.mist.com variables: {} - url: https://api.gc6.mist.com variables: {} - url: https://api.ac5.mist.com variables: {} - url: https://api.gc5.mist.com variables: {} - url: https://api.gc7.mist.com variables: {} security: - apiToken: [] - csrfToken: [] tags: - name: Orgs NAC Rules description: The NAC Rules (or Auth Policies) are a set of rules that devices and users must fulfill in order to gain access to the network and use network resources. paths: /api/v1/orgs/{org_id}/nacrules: parameters: [] get: tags: - Orgs NAC Rules summary: listOrgNacRules description: List organization NAC authentication policy rules with evaluation order. operationId: listOrgNacRules parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: limit in: query description: Maximum number of results to return per page style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 100 - name: page in: query description: Select the page number to return when using page-based pagination; starts at `1` style: form explode: true schema: minimum: 1 type: integer contentEncoding: int32 default: 1 responses: '200': description: Example response headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/nac_rule' description: List of NAC authentication policy rules examples: - - action: allow apply_tags: - string created_time: 0 id: 455f6eca-6276-4993-bfeb-53cbbbba6208 matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 454f6eca-6276-4993-bfeb-53cbbbba6308 sitegroup_ids: - 453f6eca-6276-4993-bfeb-53cbbbba6408 modified_time: 0 name: string not_matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 452f6eca-6276-4993-bfeb-53cbbbba6508 sitegroup_ids: - 451f6eca-6276-4993-bfeb-53cbbbba6608 order: 1 org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b contentMediaType: application/json examples: Example: value: - action: allow apply_tags: - string created_time: 0 id: 455f6eca-6276-4993-bfeb-53cbbbba6208 matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 454f6eca-6276-4993-bfeb-53cbbbba6308 sitegroup_ids: - 453f6eca-6276-4993-bfeb-53cbbbba6408 modified_time: 0 name: string not_matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 452f6eca-6276-4993-bfeb-53cbbbba6508 sitegroup_ids: - 451f6eca-6276-4993-bfeb-53cbbbba6608 order: 1 org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b application/vnd.api+json: schema: type: array items: $ref: '#/components/schemas/nac_rule' description: List of NAC authentication policy rules examples: - - action: allow apply_tags: - string created_time: 0 id: 455f6eca-6276-4993-bfeb-53cbbbba6208 matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 454f6eca-6276-4993-bfeb-53cbbbba6308 sitegroup_ids: - 453f6eca-6276-4993-bfeb-53cbbbba6408 modified_time: 0 name: string not_matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 452f6eca-6276-4993-bfeb-53cbbbba6508 sitegroup_ids: - 451f6eca-6276-4993-bfeb-53cbbbba6608 order: 1 org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b contentMediaType: application/vnd.api+json examples: Example: value: - action: allow apply_tags: - string created_time: 0 id: 455f6eca-6276-4993-bfeb-53cbbbba6208 matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 454f6eca-6276-4993-bfeb-53cbbbba6308 sitegroup_ids: - 453f6eca-6276-4993-bfeb-53cbbbba6408 modified_time: 0 name: string not_matching: auth_type: eap-tls nactags: - string port_types: - wireless site_ids: - 452f6eca-6276-4993-bfeb-53cbbbba6508 sitegroup_ids: - 451f6eca-6276-4993-bfeb-53cbbbba6608 order: 1 org_id: a40f5d1f-d889-42e9-94ea-b9b33585fc6b '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false post: tags: - Orgs NAC Rules summary: createOrgNacRule description: Create a NAC authentication policy rule with match and not-match criteria, an allow or block action, optional result tags, and rule priority. operationId: createOrgNacRule parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/nac_rule' - examples: - action: allow apply_tags: - c049dfcd-0c73-5014-1c64-062e9903f1e5" matching: auth_type: eap-tls nactags: - 041d5d36-716c-4cfb-4988-3857c6aa14a2 - a809a97f-d599-f812-eb8c-c3f84aabf6ba port_types: - wired site_ids: - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 sitegroup_ids: - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 name: name1 not_matching: {} order: 1 contentMediaType: application/json examples: Example: value: action: allow apply_tags: - c049dfcd-0c73-5014-1c64-062e9903f1e5" matching: auth_type: eap-tls nactags: - 041d5d36-716c-4cfb-4988-3857c6aa14a2 - a809a97f-d599-f812-eb8c-c3f84aabf6ba port_types: - wired site_ids: - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 sitegroup_ids: - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 name: name1 not_matching: {} order: 1 required: false responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/nac_rule' - description: NAC authentication policy rule that matches request criteria and applies an allow or block action contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/nac_rule' - description: NAC authentication policy rule that matches request criteria and applies an allow or block action contentMediaType: application/vnd.api+json '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false /api/v1/orgs/{org_id}/nacrules/{nacrule_id}: parameters: [] delete: tags: - Orgs NAC Rules summary: deleteOrgNacRule description: Delete an organization NAC authentication policy rule by rule ID. operationId: deleteOrgNacRule parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: nacrule_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: OK headers: {} content: {} '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false get: tags: - Orgs NAC Rules summary: getOrgNacRule description: Retrieve configuration details for a specific NAC authentication policy rule, including action, matching criteria, dry-run state, and priority. operationId: getOrgNacRule parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: nacrule_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/nac_rule' - description: NAC authentication policy rule that matches request criteria and applies an allow or block action contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/nac_rule' - description: NAC authentication policy rule that matches request criteria and applies an allow or block action contentMediaType: application/vnd.api+json '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false put: tags: - Orgs NAC Rules summary: updateOrgNacRule description: Update a NAC authentication policy rule, including match and not-match criteria, action, result tags, dry-run state, and priority. operationId: updateOrgNacRule parameters: - name: org_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab - name: nacrule_id in: path description: '' required: true schema: type: string contentEncoding: uuid examples: - 000000ab-00ab-00ab-00ab-0000000000ab requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/nac_rule' required: false responses: '200': description: Example response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/nac_rule' - description: NAC authentication policy rule that matches request criteria and applies an allow or block action contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/nac_rule' - description: NAC authentication policy rule that matches request criteria and applies an allow or block action contentMediaType: application/vnd.api+json '400': description: Bad Syntax headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http400' - description: Standard HTTP 400 bad request error response examples: - detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' contentMediaType: application/vnd.api+json examples: Example: value: detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)' '401': description: Unauthorized headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/json examples: Example: value: detail: Authentication credentials were not provided. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http401' - description: Standard HTTP 401 authentication error response examples: - detail: Authentication credentials were not provided. contentMediaType: application/vnd.api+json examples: Example: value: detail: Authentication credentials were not provided. '403': description: Permission Denied headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/json examples: Example: value: detail: You do not have permission to perform this action. application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http403' - description: Standard HTTP 403 permission error response examples: - detail: You do not have permission to perform this action. contentMediaType: application/vnd.api+json examples: Example: value: detail: You do not have permission to perform this action. '404': description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/json application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http404' - description: Standard HTTP 404 not found error response contentMediaType: application/vnd.api+json '429': description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold application/vnd.api+json: schema: allOf: - $ref: '#/components/schemas/response_http429' - description: Standard HTTP 429 rate limit error response examples: - detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold contentMediaType: application/vnd.api+json examples: Example: value: detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold deprecated: false components: schemas: nac_auth_type3: title: nac_auth_type3 enum: - cert - device-auth - eap-teap - eap-tls - eap-ttls - idp - mab - eap-peap type: string description: 'NAC authentication method that must match the request. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.' examples: - eap-tls response_http403: title: response_http403 type: object properties: detail: type: string description: Human-readable explanation of the permission error examples: - You do not have permission to perform this action. description: Standard HTTP 403 permission error response nac_rule_matching_port_type: title: nac_rule_matching_port_type enum: - wired - wireless type: string description: 'Port attachment type matched by a NAC rule. enum: `wired`, `wireless`' nac_rule_matching1: title: nac_rule_matching1 type: object properties: auth_type: allOf: - $ref: '#/components/schemas/nac_auth_type3' - description: 'NAC authentication method that must match the request. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.' examples: - eap-tls family: type: array items: type: string description: Client device family values that must match the request mfg: type: array items: type: string description: Client device manufacturer values that must match the request model: type: array items: type: string description: Client device model values that must match the request nactags: type: array items: type: string description: NAC tag IDs whose match criteria must be satisfied by the request examples: - - 041d5d36-716c-4cfb-4988-3857c6aa14a2 - a809a97f-d599-f812-eb8c-c3f84aabf6ba os_type: type: array items: type: string description: Client OS type values that must match the request port_types: type: array items: $ref: '#/components/schemas/nac_rule_matching_port_type' description: Wired or wireless access types that must match the request examples: - - wired site_ids: type: array items: type: string contentEncoding: uuid description: Site IDs where the rule criteria apply examples: - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 sitegroup_ids: type: array items: type: string contentEncoding: uuid description: Site group IDs where the rule criteria apply examples: - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 vendor: type: array items: type: string description: Client device vendor values that must match the request description: Criteria that must not match for the NAC rule to apply response_http400: title: response_http400 type: object properties: detail: type: string description: Human-readable explanation of the bad request error examples: - 'JSON parse error - Expecting value: line 5 column 8 (char 56)' description: Standard HTTP 400 bad request error response nac_rule: title: nac_rule required: - action - name type: object properties: action: allOf: - $ref: '#/components/schemas/nac_rule_action2' - description: Allow or block decision applied when the NAC rule matches examples: - allow apply_tags: type: array items: type: string description: NAC tag IDs to include in the Access-Accept when the rule allows access examples: - - c049dfcd-0c73-5014-1c64-062e9903f1e5 created_time: type: number description: Epoch timestamp when the NAC rule was created readOnly: true dry_run: type: boolean description: Whether the NAC rule is in dry-run mode, where matches are logged but the action is not enforced enabled: type: boolean description: Whether the NAC rule is evaluated during policy matching default: true guest_auth_state: allOf: - $ref: '#/components/schemas/nac_rule_guest_auth_state2' - description: 'Guest portal authorization state condition for the rule. enum: `authorized`, `unknown`.' examples: - authorized id: type: string description: Unique identifier of the NAC rule contentEncoding: uuid readOnly: true examples: - 53f10664-3ce8-4c27-b382-0ef66432349f matching: allOf: - $ref: '#/components/schemas/nac_rule_matching3' - description: Criteria that must match for the NAC rule to apply modified_time: type: number description: Epoch timestamp when the NAC rule was last modified readOnly: true name: type: string description: Human-readable name of the NAC rule not_matching: allOf: - $ref: '#/components/schemas/nac_rule_matching1' - description: Criteria that must not match for the NAC rule to apply order: minimum: 0 type: integer description: Rule priority; lower values are evaluated with higher priority contentEncoding: int32 examples: - 1 org_id: type: string description: Org identifier that owns the NAC rule contentEncoding: uuid readOnly: true examples: - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61 description: NAC authentication policy rule that matches request criteria and applies an allow or block action response_http404: title: response_http404 type: object properties: id: type: string description: Missing resource identifier, when the API includes one description: Standard HTTP 404 not found error response response_http401: title: response_http401 type: object properties: detail: type: string description: Human-readable explanation of the authentication error examples: - Authentication credentials were not provided. description: Standard HTTP 401 authentication error response response_http429: title: response_http429 type: object properties: detail: type: string description: Human-readable explanation of the rate limit error examples: - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold description: Standard HTTP 429 rate limit error response nac_rule_action2: title: nac_rule_action2 enum: - allow - block type: string description: Allow or block decision applied when the NAC rule matches examples: - allow nac_rule_guest_auth_state2: title: nac_rule_guest_auth_state2 enum: - authorized - unknown type: string description: 'Guest portal authorization state condition for the rule. enum: `authorized`, `unknown`.' examples: - authorized nac_rule_matching3: title: nac_rule_matching3 type: object properties: auth_type: allOf: - $ref: '#/components/schemas/nac_auth_type3' - description: 'NAC authentication method that must match the request. enum: `cert`, `device-auth`, `eap-teap`, `eap-tls`, `eap-ttls`, `idp`, `mab`, `eap-peap`.' examples: - eap-tls family: type: array items: type: string description: Client device family values that must match the request mfg: type: array items: type: string description: Client device manufacturer values that must match the request model: type: array items: type: string description: Client device model values that must match the request nactags: type: array items: type: string description: NAC tag IDs whose match criteria must be satisfied by the request examples: - - 041d5d36-716c-4cfb-4988-3857c6aa14a2 - a809a97f-d599-f812-eb8c-c3f84aabf6ba os_type: type: array items: type: string description: Client OS type values that must match the request port_types: type: array items: $ref: '#/components/schemas/nac_rule_matching_port_type' description: Wired or wireless access types that must match the request examples: - - wired site_ids: type: array items: type: string contentEncoding: uuid description: Site IDs where the rule criteria apply examples: - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 sitegroup_ids: type: array items: type: string contentEncoding: uuid description: Site group IDs where the rule criteria apply examples: - - bb19fc3e-4124-4b57-80d9-c3f6edce47c4 - bb19fc3e-6564-4b57-80d9-c3f6edce47c1 vendor: type: array items: type: string description: Client device vendor values that must match the request description: Criteria that must match for the NAC rule to apply securitySchemes: apiToken: type: apiKey description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed." name: Authorization in: header csrfToken: type: apiKey description: 'Session-based authentication for browser or login/password flows. After a successful [Login]($e/Admins%20Login/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session. **Format**: ``` X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx ``` For automation, API Token authentication is preferred.' name: X-CSRFToken in: header