Cisco Secure Client AccessPolicies API

The AccessPolicies API from Cisco Secure Client — 1 operation(s) for accesspolicies.

OpenAPI Specification

cisco-secure-client-accesspolicies-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cisco Secure Firewall Management Center API (Secure Client management plane) AccessPolicies API
  description: 'The Cisco Secure Firewall Management Center (FMC) REST API configures

    remote-access VPN gateways, group policies, devices, and Secure Client

    profiles distributed to endpoints. Authentication uses a token generated

    via the generatetoken endpoint and passed as the X-auth-access-token

    header on subsequent calls; the response also returns an

    X-auth-refresh-token used to refresh.

    '
  version: 1.0.0
  contact:
    name: Cisco DevNet
    url: https://developer.cisco.com/docs/secure-firewall-management-center-api/
servers:
- url: https://{fmcHost}
  variables:
    fmcHost:
      default: fmc.example.com
      description: Hostname of the Secure Firewall Management Center
security:
- tokenAuth: []
tags:
- name: AccessPolicies
paths:
  /api/fmc_config/v1/domain/{domainUUID}/policy/accesspolicies:
    parameters:
    - in: path
      name: domainUUID
      required: true
      schema:
        type: string
    get:
      tags:
      - AccessPolicies
      summary: List access policies
      operationId: listAccessPolicies
      parameters:
      - in: query
        name: offset
        schema:
          type: integer
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: expanded
        schema:
          type: boolean
      responses:
        '200':
          description: A list of access policies
    post:
      tags:
      - AccessPolicies
      summary: Create an access policy
      operationId: createAccessPolicy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessPolicy'
      responses:
        '201':
          description: Created access policy
components:
  schemas:
    AccessPolicy:
      type: object
      properties:
        type:
          type: string
          enum:
          - AccessPolicy
        name:
          type: string
        defaultAction:
          type: object
          properties:
            action:
              type: string
              enum:
              - BLOCK
              - TRUST
              - PERMIT
              - NETWORK_DISCOVERY
              - INHERIT_FROM_PARENT
            logBegin:
              type: boolean
            logEnd:
              type: boolean
            sendEventsToFMC:
              type: boolean
        description:
          type: string
        id:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    tokenAuth:
      type: apiKey
      in: header
      name: X-auth-access-token