Applicazione dei requisiti di sicurezza su una API

Modifica online

Per applicare i requisiti di sicurezza su un'API, applicare gli schemi di sicurezza precedentemente creati che specificano vari aspetti della configurazione della sicurezza API.

Informazioni su questa attività

Nota: questa attività fa riferimento alla configurazione di una definizione API OpenAPI 2.0 . Per i dettagli su come configurare una definizione API OpenAPI 3.0 , vedi Modifica di una definizione API OpenAPI 3.0.

Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.

Per ulteriori informazioni su come creare e configurare le definizioni degli schemi di sicurezza, consultare la sezione Definizione degli schemi di sicurezza.

Le seguenti limitazioni esistono quando si applicano gli schemi di sicurezza a un'API:
  • Non puoi applicare più di due schemi di sicurezza della chiave API a un'API.
  • Se si applica uno schema di sicurezza della chiave API per il segreto client, è necessario applicare anche uno schema di sicurezza della chiave API per l'ID client.
  • Se si richiede allo sviluppatore dell'applicazione di fornire sia l'ID client che il segreto client, è necessario applicare due schemi di sicurezza della chiave API separati.
  • È possibile avere al massimo uno schema di chiavi API di tipo ID client, indipendentemente dal fatto che l'ID client sia stato inviato nell'intestazione della richiesta o come parametro di query.
  • È possibile disporre al massimo di uno schema di chiavi API di tipo segreto client, indipendentemente dal fatto che il segreto client venga inviato nell'intestazione della richiesta o come parametro di query.
  • Non è possibile applicare più di uno schema di sicurezza di base a un'API. Se si applica uno schema di sicurezza di base, non è possibile applicare anche uno schema di sicurezza di tipo « OAuth ».
  • È possibile applicare al massimo un schema di sicurezza " OAuth " a un'API.

Un requisito di sicurezza specifica uno o più schemi di sicurezza le cui condizioni devono essere tutte soddisfatte affinché l'API venga richiamata correttamente. Puoi definire più requisiti di sicurezza; in questo caso, un'applicazione può richiamare la tua API se soddisfa uno dei requisiti di sicurezza che hai definito.

In qualsiasi momento puoi passare direttamente al codice sorgente YAML sottostante dell' OpenAPI, cliccando Icona origine OpenAPI sull'icona "Sorgente". Per tornare al modulo di progettazione, clicca sull'icona Icona moduloModulo.

Procedura

  1. Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 2.0.
  2. Espandi Generale.
  3. Per creare un nuovo requisito di sicurezza per l'API, completare la seguente procedura:
    1. Fai clic sull'icona "Aggiungi" accanto Icona OpenAPI 2.0 API add alla voce "Sicurezza" nel riquadro di navigazione.
    2. Selezionare gli schemi di protezione che si desidera includere in questo requisito di protezione. Gli schemi di sicurezza elencati sono quelli che sono stati definiti; si veda la sezione "Definizione degli schemi di sicurezza".

      Se lo schema di sicurezza selezionato è di tipo " OAuth2 ", selezionare gli ambiti richiesti; gli ambiti disponibili per la selezione sono quelli specificati nello schema di sicurezza; per ulteriori informazioni, consultare la sezione "Definizione degli schemi di sicurezza ' OAuth2 '".

      Se si applica lo schema di sicurezza " OAuth2 " a un'API gestita dal provider nativo " OAuthDataPower® API Gateway", è necessario selezionare un ambito solo se l'opzione "Controllo avanzato dell'ambito dopo la generazione del token" non è abilitata nel provider nativo "" associato allo schema di sicurezza. Se nel provider nativo OAuth è stato impostato un ambito predefinito e la richiesta API non contiene alcun ambito, viene utilizzato l'ambito predefinito; per ulteriori informazioni, consultare la sezione Configurazione degli ambiti per un provider nativo OAuth.

      Nota: il seguente requisito aggiuntivo si applica ai sistemi di sicurezza che saranno utilizzati con un fornitore terzo di servizi di autenticazione ( OAuth ). Se si seleziona uno schema di sicurezza " OAuth " per proteggere un'API consumer, è necessario includere anche uno schema di sicurezza basato su chiave API, poiché o client_idX-IBM-Client-Id devono essere inclusi nelle credenziali di sicurezza affinché possano essere applicate le impostazioni di configurazione corrette del piano.
    3. Fai clic su Crea. Vengono visualizzate le selezioni dello schema di sicurezza; è possibile modificarle nuovamente prima del salvataggio.
    4. Al termine, fare clic su Inoltra .
  4. Per modificare un requisito di protezione esistente, completare la seguente procedura:
    1. Fare clic su Sicurezza nel riquadro di spostamento. Vengono elencati tutti i requisiti di sicurezza precedentemente definiti; vengono visualizzati gli schemi di sicurezza inclusi in ciascun requisito di sicurezza.
    2. Per modificare le impostazioni di sicurezza relative a un requisito di sicurezza, clicca sull'icona di modifica Icona di modifica requisito di protezione accanto al requisito in questione, quindi modifica le impostazioni come desideri.
    3. Al termine, fare clic su Inoltra , quindi su Salva.
    4. Per eliminare un requisito di sicurezza, fare clic sull'icona di eliminazione Icona Elimina requisito di protezione corrispondente, fare clic su Elimina per confermare, quindi fare clic su Salva.
    5. Per disattivare la sicurezza per l'API, deselezionare la check box Richiedi uno dei seguenti requisiti di protezione , quindi fare clic su Salva.