Definizione di un sistema di sicurezza dei portatori di e HTTP

Un sistema di sicurezza basato su portatori di chiavi ( HTTP ) viene utilizzato per generare token di accesso che vengono scambiati tra il server e il client quando si chiamano le operazioni API.

Informazioni su questa attività

Per informazioni sull'uso dei token Bearer con le API di OpenAPI 3, consultare la sezione "Bearer Authentication" nella specifica di OpenAPI 3.

Se nella richiesta viene trovato un token portatore di un' HTTP, il suo valore viene memorizzato nel contesto come api->security->bearer_token. Se viene invocata una convalida esterna dell' URL, qualsiasi risposta con un codice di stato 200 viene memorizzata nel contesto come api->security->bearer_validation_response.

Nota:

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

In qualsiasi momento, è possibile passare direttamente all'origine YAML di OpenAPI facendo clic sull'icona Sorgente Icona origine OpenAPI. Per tornare al modulo di progettazione, fare clic sull'icona Modulo Icona modulo.

Procedura

  1. Apri l'API per la modifica, come descritto in Modifica di una definizione API OpenAPI 3.0.
  2. Espandere Componenti > Schemi di sicurezza.
  3. Fare clic su Aggiungi.
  4. Nella finestra di dialogo Aggiungi oggetto , fornire le seguenti informazioni:
    • Nome schema di sicurezza (chiave) - Fornire un nome descrittivo per il nuovo schema.
    • Tipo di schema di sicurezza - Selezionare HTTP.
    • Schema - Selezionare Bearer.
    • Formato connessione - Selezionare JWT.
    • Metodo di convalida - Selezionare un metodo. Se si seleziona external - url, fornire le seguenti informazioni aggiuntive:
      • Validation Endpoint (Punto finale di convalida ): fornisce l' URL e del server utilizzato per la convalida. Per garantire una connessione sicura, l' URL e dovrebbe utilizzare il protocollo https .
      • TLS Nome profilo : se l'endpoint di convalida utilizza il https protocollo, selezionare il nome del profilo client TLS da utilizzare per una connessione sicura.
    • Descrizione - Fornire una descrizione dello schema JWT.
  5. Fare clic su Crea per creare il nuovo schema.
  6. Fare clic su Salva nell'intestazione della pagina.