Authentication

Cisco Cyber Vision center has four default user roles, Admin, Auditor, Operator, and Product. Only the Admin role has API write permissions. You can also create custom roles and assign API read or write permissions to it.

Generate an API Token

The Cisco Cyber Vision API require token-based access via an authenticated and authorized account. You can create and manage API access tokens in the Cisco Cyber Vision Center classic UI.

  1. Log in to your Cisco Cyber Vision Center.
  2. Choose Admin > API > Token.
  3. Any available API token is listed in this page. To create a new token, click New Token. If there are no available API tokens, click Create your first token.
  4. In the Token dialog box:
    1. Enter a name for the token.
    2. The Status toggle button is enabled by default. You can modify the status if you don't want to use the token immediately.
    3. You can choose to set an expiry date for the token. If you don't want to set an expiry date, click the Expiration Time toggle button to off.
    4. Click Save.

The newly created API token is displayed in the API page.

For each API token, the Actions column contains the following actions for the token:

  1. Edit.
  2. Enable or disable.
  3. Delete.

When a token expires, you must generate a new token to authorize APIs.

Authenticate with the API Token

To authenticate multiple networks using the generated API token, add the x-token-id field in the header.

curl -X 'GET' \
  'https://<center IP>/api/3.0/networks/' \
  -H 'accept: application/json' \
  -H 'x-token-id: ics-458dfdf1d26241dadc7428ad1deca7e9ce3fdd47ca6bae'

Response

[
  {
    "id": "86bc937a-19cf-5f0a-9b28-1f9a8347590e",
    "name": "10/8 private network",
    "type": "OT Internal",
    "ipRange": "10.0.0.0/8",
    "vlanId": null,
    "duplicated": false,
    "splitDevicesPerSensor": false
  },
  {
    "id": "6d98a2f7-ab5b-5f91-a375-a14f88a9e963",
    "name": "IPv4 loopback",
    "type": "OT Internal",
    "ipRange": "127.0.0.0/8",
    "vlanId": null,
    "duplicated": false,
    "splitDevicesPerSensor": false
  }
]

Authorization

To authorize API and test request payloads, in the Getting Started chapter, see the topic Try Out Cisco Cyber Vision APIs.