Action d'API personnalisée

Adressez une requête HTTP authentifiée à l'API KnowBe4.

Options

Champ Définition Type Obligatoire

Type de requête

Voici les méthodes de requête HTTP prises en charge, ou verbes HTTP, dans un appel API personnalisé (voir Méthodes de requête HTTP).

  • GET : Récupère des données d'un serveur web en fonction des paramètres. Cette méthode demande une représentation de la ressource spécifiée. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé avec le contenu demandé.

  • POST : envoie des données à un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Plusieurs requêtes POST peuvent produire un résultat différent de celui d'une seule requête POST. Il convient de faire preuve de prudence afin d'éviter d'envoyer involontairement plusieurs requêtes POST. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé.

  • PUT : envoie des données à stocker à un emplacement spécifique sur un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Contrairement aux requêtes POST, les requêtes PUT sont idempotentes. Pour les requêtes réussies, le résultat d'une seule requête PUT est le même que celui de plusieurs requêtes PUT identiques. Si une requête aboutit, un message de réponse 200 (OK), 201 (Created) ou 204 (No Content) est renvoyé.

  • PATCH : applique des modifications partielles à une ressource sur un serveur Web en fonction des paramètres. PATCH n'est pas idempotent. Les requêtes PATCH multiples pourraient avoir des conséquences inattendues. Si une requête PATCH aboutit, un message de réponse 200 (OK) ou 204 (No Content) est retourné.

  • DELETE : supprime la ressource spécifiée (si elle existe) du serveur Web en fonction des paramètres. Si une requête DELETE aboutit, un message de réponse 200 (OK) est retourné.

 Liste déroulante TRUE

Entrée

Champ Définition Type Obligatoire

Requête

URL relative

L'adresse URL du serveur Web que vous tentez d'appeler. Spécifiez l'URL relative en tant que /{insert_remaining_URL}.

Vous pouvez spécifier les paramètres de la requête dans l'URL relative en utilisant « ? » ou spécifier les paramètres de la requête comme une paire de clés de l'objet dans l'entrée de requête.

Par exemple pour un KnowBe4 point de terminaison de l'API de création de rapportshttps://{region}.api.knowbe4.com/v1/users/{user_id}, l'URL relative est /v1/users/{user_id}.

 Texte TRUE

Requête

Spécifiez, au format objet (paires clé-valeur), les paramètres de requête supplémentaires à inclure.

Par exemple : {"name":"something-urgent"}

Objet FALSE

En-têtes

Spécifiez les en-têtes requis en plus d'authorization ou de content-type (ce connecteur gère déjà ces en-têtes).

Par exemple : {"Content-type":"application/json"}

Objet FALSE

Corps

Spécifiez un corps de requête au format JSON.

Ce champ n'est pas disponible pour le type de requête GET.

 Objet FALSE

Sortie

Champ Définition Type

Réponse

Code de statut

Résultat de l'opération. Le connecteur retourne un code de statut HTTP qui indique si l'action effectuée par la carte a réussi ou échoué. Par exemple :

  • Un code de statut 201 Created indique un succès où une nouvelle ressource a été créée.
  • Une erreur 403 Forbidden indique que la requête HTTP n'a pas été traitée parce que les permissions nécessaires étaient manquantes.

Pour une liste complète des codes de statut possibles, voir Codes de statut HTTP.

 Nombre

En-têtes

Contexte détaillé du code de statut, sans lien avec le corps de la sortie. Les en-têtes de réponse dépendent de l'option de requête HTTP sélectionnée. Tous les en-têtes ne sont pas des en-têtes de réponse. Ceci est semblable à {"Content-type":"application/json"}.

 Objet

Corps

Données retournées par votre requête HTTP sélectionnée.

Par exemple, les données d'une requête GET.

 Objet