API REST¶

Gli amministratori creano token Bearer con scope definiti per applicazioni esterne.

Panoramica¶

Questa pagina descrive l’utilizzo e gli effetti principali di API REST. Se le modifiche influiscono su ticket, autorizzazioni, notifiche o automazioni esistenti, devono essere verificate prima in un ambiente di test.

Flusso di lavoro tipico¶

Cercare un utente per un token. Utilizzare le viste disponibili di ricerca, filtro e dettaglio. Cancellare o modificare i filtri se i record previsti non vengono visualizzati.
Creare un token con nome e scope. Aprire il modulo di gestione o azione corrispondente, inserire i valori necessari e salvare solo dopo aver verificato assegnazioni e campi obbligatori.
Acquisire in modo sicuro il valore del token. Eseguire la funzione nel modulo previsto e controllare immediatamente il risultato nella vista corrispondente o nel ticket interessato.
Disattivare il token. Controllare prima quali record o utenti esistenti sono interessati. Se possibile, utilizzare la disattivazione invece della rimozione definitiva.
Comprendere la registrazione delle richieste e l’idempotenza. Eseguire la funzione nel modulo previsto e controllare immediatamente il risultato nella vista corrispondente o nel ticket interessato.
Aprire la descrizione OpenAPI. Eseguire la funzione nel modulo previsto e controllare immediatamente il risultato nella vista corrispondente o nel ticket interessato.

Note¶

Le voci di menu e le azioni visibili dipendono dalle autorizzazioni di gruppo e di programma dell’agente connesso.
Le voci disattivate vengono spesso mantenute per ticket e valutazioni esistenti, ma non sono più disponibili per nuove assegnazioni.
Dopo le modifiche, verificare almeno un caso d’uso realistico con un utente del ruolo interessato.