Sommario

Introduzione

Prerequisiti

Requisiti

Componenti usati

Configurazione

1. Creare la chiave API

2. Generare un token di accesso API

3.Gestisci elenchi destinazioni

Ottieni tutti gli elenchi di destinazione

Ottenere tutte le destinazioni all'interno di un elenco destinazioni

Crea un nuovo elenco destinazioni

Aggiungere destinazioni a un elenco destinazioni

Eliminare un elenco di destinazione

Eliminare le destinazioni da un elenco destinazioni

Risoluzione dei problemi

Informazioni correlate

Introduzione

In questo documento viene descritto come gestire gli elenchi di destinazione tramite curl con Secure Access API.

Prerequisiti

Requisiti

Cisco raccomanda la conoscenza dei seguenti argomenti:

- Accesso sicuro

- API Secure Access

- ricciolo

- Json

Componenti usati

Le informazioni fornite in questo documento si basano sulle seguenti versioni software e hardware:

- Accesso sicuro

- API Secure Access

- ricciolo

- Json

Le informazioni discusse in questo documento fanno riferimento a dispositivi usati in uno specifico ambiente di emulazione. Su tutti i dispositivi menzionati nel documento la configurazione è stata ripristinata ai valori predefiniti. Se la rete è operativa, valutare attentamente eventuali conseguenze derivanti dall'uso dei comandi.

Configurazione

1. Creare la chiave API

Passare a Dashboard di accesso protetto.

- Fare clic su Admin > Api Keys > Add

Creare la chiave API 1

Creare la chiave API 2

- Aggiungere API Key Name , Description (Optional) desiderato Expiry Date, se necessario

Creare la chiave API 3

- In Key Scope, scegliere Policies quindi Espandi criteri

- Scegli Destination Lists e Destinations

- Modificare Scope se necessario, altrimenti conservare come Read/Write

- Fare clic su CREATE KEY

Creare la chiave API 4

- Copiare API Keye Key Secret e quindi fare clic su ACCEPT AND CLOSE

Creare la chiave API 5

Nota: esiste solo un'opportunità per copiare il segreto API. Secure Access non salva il segreto API e non è possibile recuperarlo dopo la creazione iniziale.

2. Generare un token di accesso API

Per generare il token di accesso API, creare una richiesta di autorizzazione token:

Richiesta di autorizzazione token

Utilizzare le credenziali dell'API Secure Access create per l'organizzazione per generare un token di accesso API.

- Nell'esempio di ricciolo, sostituire la chiave e il segreto dell'API Secure Access

curl --user key:secret --request POST --url https://api.sse.cisco.com/auth/v2/token -H Content-Type: application/x-www-form-urlencoded -d grant_type=client_credentials

- Copiare e salvare il token Bearer API generato

Nota: un token di accesso Secure Access OAuth 2.0 scade tra un'ora (3600 secondi). È consigliabile non aggiornare un token di accesso fino a quando il token è quasi scaduto.

3.Gestisci elenchi destinazioni

Gli elenchi di destinazione possono essere gestiti in diversi modi, ad esempio:

Ottieni tutti gli elenchi di destinazione

Aprire il prompt dei comandi di Windows o il terminale Mac per eseguire il comando:

curl -L --location-trusted --request GET --url https://api.sse.cisco.com/policies/v2/destinationlists -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json"

Frammento di codice da output di esempio:

{"id":23456789,"organizationId":1234567,"access":"none","isGlobal":false,"name":" Test Block list","thirdpartyCategoryId":null,"createdAt":1694070823,"modifiedAt":1702819637,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":2,"meta": {"destinationCount":2,"domainCount":2,"urlCount":0,"ipv4Count":0,"applicationCount":0}

Prendere nota dell'elemento destinationListId elencato nel campo "id" dell'output che viene utilizzato ulteriormente per le richieste GET, POST o DELETE specifiche di questo elenco di destinazione.

Ottenere tutte le destinazioni all'interno di un elenco destinazioni

- Ottieni il destinationListId utilizzando questo passaggio della citazione precedente, Ottieni tutti gli elenchi di destinazione

Aprire il prompt dei comandi di Windows o il terminale Mac per eseguire il comando:

curl -L --location-trusted --request GET --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId/destinations -H "Authorization: Bearer YourAccessToken"

Output di esempio:

{"status":{"code":200,"text":"OK"},"meta":{"page":1,"limit":100,"total":3},"data": [ {"id":"415214","destination":"cisco.com","type":"domain","comment":null,"createdAt":"2024-02-20 09:15:46"},{"id":"7237895","destination":"www.cisco.com","type":"domain","comment":null,"createdAt":"2024-02-20 10:19:51"},{"id":"29275814","destination":"10.10.10.10","type":"ipv4","comment":null,"createdAt":"2024-02-20 09:15:46"},{"id":"71918495","destination":"www.subdomain.cisco.com/resoucre","type":"url","comment":null,"createdAt":"2024-02-20 10:29:02"} ]}

Crea un nuovo elenco destinazioni

Aprire il prompt dei comandi di Windows o il terminale Mac per eseguire il comando:

curl -L --location-trusted --request POST --url https://api.sse.cisco.com/policies/v2/destinationlists -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -H "Accept: application/json" -d "{\"access\":\"none\",\"isGlobal\":false,\"name\":\"Destination List Name\"}"

Nota: sostituire 'Nome elenco di destinazione' con il nome desiderato.

Output di esempio:

{"id":23456789,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708417690,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta":{"destinationCount":0}}

Aggiungere destinazioni a un elenco destinazioni

- Ottieni il destinationListId utilizzando questo passaggio della citazione precedente, Ottieni tutti gli elenchi di destinazione

Aprire il prompt dei comandi di Windows o il terminale Mac per eseguire il comando:

curl -L --location-trusted --request POST --url https://api.sse.cisco.com/policies/v2/destinationlists/{destinationListId}/destinations -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -d "[{\"destination":"cisco.com\"},{\"destination\":\"10.10.10.10\"},{\"destination\":\"www.subdomain.cisco.com\/resource\"}]"

Output di esempio:

{"status":{"code":200,"text":"OK"},"data":{"id":17804929,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708420546,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta": {"destinationCount":3}}}

Eliminare un elenco di destinazione

- Ottieni il destinationListId utilizzando questo passaggio della citazione precedente, Ottieni tutti gli elenchi di destinazione

Aprire il prompt dei comandi di Windows o il terminale Mac per eseguire il comando:

curl -L --location-trusted --request DELETE --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId -H "Authorization: Bearer YourAccessToken"

Output di esempio:

{"status":{"code":200,"text":"OK"},"data":[]}

Eliminare le destinazioni da un elenco destinazioni

- Ottieni il destinationListId utilizzando questo passaggio della citazione precedente, Ottieni tutti gli elenchi di destinazione

- Ottenere il nome id della destinazione specifica all'interno dell'elenco che deve essere eliminato utilizzando questo passaggio precedente, Ottenere tutte le destinazioni all'interno di un elenco di destinazione

Aprire il prompt dei comandi di Windows o il terminale Mac per eseguire il comando:

curl -L --location-trusted --request DELETE --url https://api.sse.cisco.com/policies/v2/destinationlists/destinationListId/destinations/remove -H "Authorization: Bearer YourAccessToken" -H "Content-Type: application/json" -H "Accept: application/json" -d "[id1,id2]"

Output di esempio:

{"status":{"code":200,"text":"OK"},"data":{"id":17804929,"organizationId":1234567,"access":"none","isGlobal":false,"name":"API List 1","thirdpartyCategoryId":null,"createdAt":1708417690,"modifiedAt":1708525645,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":1,"meta":{"destinationCount":2}}}

Risoluzione dei problemi

Gli endpoint API di accesso sicuro utilizzano i codici di risposta HTTP per indicare l'esito positivo o negativo di una richiesta API. In generale, i codici nell'intervallo 2xx indicano un esito positivo, i codici nell'intervallo 4xx indicano un errore risultante dalle informazioni fornite e i codici nell'intervallo 5xx indicano errori del server. L'approccio per risolvere il problema dipende dal codice di risposta ricevuto:

API REST - Codici di risposta 1

API REST - Codici di risposta 2

Inoltre, durante la risoluzione dei problemi relativi agli errori o ai problemi dell'API, è necessario conoscere i seguenti limiti di velocità:

- Limiti dell'API Secure Access

Informazioni correlate

- Guida per l'utente di Cisco Secure Access

- Supporto tecnico Cisco e download

- Aggiungi chiavi API di accesso sicuro

- Guida per l'utente per gli sviluppatori