Secure Email Threat Defense API

Authentication

The Secure Email Threat Defense API requires an authentication token in each request. You can obtain the token by sending an HTTPS POST to the Secure Email Threat Defense API servers to a specific URL and passing in the Client ID and Client Secret.

You will need to login to Secure Email Threat Defense and create your API Client Credentials.

Note: Only admin and super-admin users can generate API Client Credentials.

To create the API Client Credentials:

  1. Log into the Secure Email Threat Defense UI.

  2. Navigate to Administration > API Clients.

Note: Only admin and super admin users can access this tab and generate API Client Credentials. Other users can't access this tab.

  1. To generate a Client ID and a Secret, click + Add New Client.
  2. Enter the Client Name and Description (optional) and click Submit.

Your Client ID and Password are now generated.

Note: You must copy and save the Client Password. It cannot be recovered by Cisco.

You also need to generate an API Key. To do so, on the API Key page, click Generate New Key. The generated API Key is required for all the client IDs and will be used in the header to call all the APIs. For more details go to Rate Limiting in the Guides section of this document.

To delete a Client ID, on the API Clients page, click x at the end of a row.

With the generated Client ID, Client Secret, and API Key, you can use your regional endpoint to get the JWT token.

Available authentication API endpoints are:

Americas API endpoint: https://api.us.etd.cisco.com/v1/oauth/token

Europe API endpoint: https://api.de.etd.cisco.com/v1/oauth/token

Australia API endpoint: https://api.au.etd.cisco.com/v1/oauth/token

India API endpoint: https://api.in.etd.cisco.com/v1/oauth/token

Example of an authentication API request using CURL:

curl
Copy  curl --location --request POST 'https://api.us.etd.cisco.com/v1/oauth/token' \
--header 'x-api-key: apikeytest' \
-u <client_id>:<client_secret>

Note: The JWT expiration period is 60 minutes. After this, you must generate a new JWT to proceed with the Secure Email Threat Defense API.

Next