Action d'API personnalisée

Utilisez l'action d'API personnalisée pour adresser une requête authentifiée à l'API Okta.

Consultez la Oktaréférence de l'API pour en savoir plus sur le travail direct avec l'API Okta.

Permissions

Consultez Cartes d'action pour obtenir la liste des permissions OAuth requises pour cette carte.

Options

Champ Définition Type Obligatoire

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é. `GET(Streaming)` : diffuse les données d'un serveur Web en fonction des paramètres de la méthode HTTP `GET` et des champs de saisie Diffusion en flux continu associés. Si l'URL liée fournie ne prend pas en charge la pagination, la carte effectue une requête `GET` normale et n'envoie qu'un seul enregistrement au flux d'aide. La valeur de Enregistrements diffusés en flux continu est alors définie sur `1` (quelle que soit la valeur de la limite d'enregistrements). Le processus de diffusion en flux continu prend fin. Vous pouvez fournir un paramètre `limit` à utiliser pour la pagination en le saisissant dans le champ Requête. La plage de valeurs valides est comprise entre `0` et `200`. Si aucune valeur n'est fournie, la valeur `200` est utilisée comme limite par défaut. Dans la plupart des cas, il n'est pas nécessaire de configurer une limite manuellement. Cependant, si chaque charge utile renvoyée par votre point de terminaison approche 1 Mo, le fait de fournir une limite inférieure à `200` évite de dépasser la limite de mémoire du flux. `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 aboutir à un résultat différent d'un seul POST. Soyez prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête réussit, un message de réponse `200 (OK)` est retourné. `PUT` : Envoie des données à stocker à un emplacement spécifique sur un serveur web en fonction des paramètres, comme charger 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 plusieurs requêtes PUT identiques. Si une requête réussit, un message de réponse `200 (OK)`, `201 (Created)` ou `204 (No Content)` est retourné. `PATCH` : Applique des modifications partielles à une ressource sur un serveur web en fonction des paramètres. PATCH n'est pas idempotente. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si un PATCH réussit, 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 renvoyé.	Liste déroulante	TRUE

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é.
GET(Streaming) : diffuse les données d'un serveur Web en fonction des paramètres de la méthode HTTP GET et des champs de saisie Diffusion en flux continu associés.

Si l'URL liée fournie ne prend pas en charge la pagination, la carte effectue une requête GET normale et n'envoie qu'un seul enregistrement au flux d'aide. La valeur de Enregistrements diffusés en flux continu est alors définie sur 1 (quelle que soit la valeur de la limite d'enregistrements). Le processus de diffusion en flux continu prend fin.

Vous pouvez fournir un paramètre limit à utiliser pour la pagination en le saisissant dans le champ Requête. La plage de valeurs valides est comprise entre 0 et 200. Si aucune valeur n'est fournie, la valeur 200 est utilisée comme limite par défaut. Dans la plupart des cas, il n'est pas nécessaire de configurer une limite manuellement. Cependant, si chaque charge utile renvoyée par votre point de terminaison approche 1 Mo, le fait de fournir une limite inférieure à 200 évite de dépasser la limite de mémoire du flux.
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 aboutir à un résultat différent d'un seul POST. Soyez prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête réussit, un message de réponse 200 (OK) est retourné.
PUT : Envoie des données à stocker à un emplacement spécifique sur un serveur web en fonction des paramètres, comme charger 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 plusieurs requêtes PUT identiques. Si une requête réussit, un message de réponse 200 (OK), 201 (Created) ou 204 (No Content) est retourné.
PATCH : Applique des modifications partielles à une ressource sur un serveur web en fonction des paramètres. PATCH n'est pas idempotente. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si un PATCH réussit, 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éponse200 (OK) est renvoyé.

Liste déroulante

TRUE

Entrée

Champ	Définition	Type	Obligatoire
URL liée	L'adresse (URL) du serveur Web que vous essayez d'appeler. Spécifiez l'URL liée comme suit : `/{insert_remaining_URL}`. Vous pouvez spécifier les paramètres de la requête dans l'URL liée 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. Une URL liée doit commencer par le caractère `/`. Par exemple, pour le point de terminaison de l'API Okta : l'URL relative de `https://{yourOktaDomain}/api/v1/users` est `/api/v1/users`. Consultez API Okta.	Texte	TRUE
En-têtes	Spécifiez les en-têtes requis en plus de l'autorisation ou du type de contenu (ceux-ci sont déjà gérés par ce connecteur).	Objet	FALSE
Requête	Indiquez tout paramètre de requête supplémentaire à inclure dans le format de l'objet (paires clé-valeur).	Objet	FALSE
Corps	Spécifiez un corps de requête au format JSON. Disponible uniquement pour les requêtes `POST`, `PUT` et `PATCH`.	Objet	FALSE
Diffusion en flux continu
Flux	Cliquez sur Choisir un flux pour parcourir et sélectionner un flux auxiliaire où les résultats de recherche seront diffusés, puis cliquez sur Choisir pour confirmer. De façon optionnelle, cliquez sur le champ vide sous Cliquez ou déposez ici pour créer et ajoutez des champs extensibles personnalisés qui transmettent des données au flux auxiliaire. Ces champs sont ajoutés en tant que paires clé/valeur sous l'objet de sortie État dans le flux d'aide. Ce champ s'affiche lorsque vous sélectionnez `GET(Streaming)` dans l'option Type de requête.	Flux	TRUE
Limite d'enregistrements	Indiquez le nombre d'enregistrements à diffuser en flux continu. Lorsque le champ est défini sur une valeur inférieure à `0`, la carte renvoie une erreur. Lorsque le champ est défini sur `0` ou sur une valeur supérieure à `0`, le flux renvoie renvoie jusqu'au nombre maximum spécifié. Lorsque le champ est vide, null ou non sélectionné, le flux renvoie tous les enregistrements. La valeur par défaut est `1000000` (1 million). La plage de valeurs valides est comprise entre `0` et `1000000`. Ce champ s'affiche lorsque vous sélectionnez `GET(Streaming)` dans l'option Type de requête. Le paramètre `limit` que vous pouvez définir dans le champ de saisie Requête représente le nombre d'enregistrements renvoyés pour chaque page dans une requête de pagination, mais le champ Limite d'enregistrements représente le nombre total d'enregistrements que vous souhaitez diffuser en flux continu. La limite d'enregistrement maximale est égale à 5 000 fois la valeur du paramètre limit. Comme la `limit` par défaut est de `200`, la limite d'enregistrements maximale par défaut est de 1 000 000 (soit 200 * 5 000). Si vous définissez manuellement le paramètre `limit`, vous devez calculer la limite d'enregistrements maximale. Par exemple, si vous spécifiez `limit=1`, le nombre maximal d'enregistrements que vous pouvez obtenir est de 5 000, même si vous indiquez un nombre supérieur à `5000` dans le champ Limite d'enregistrements.	Nombre	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
Enregistrements diffusés en flux continu	Nombre d'enregistrements transmis en flux continu dans un flux de streaming. Ce champ s'affiche lorsque vous sélectionnez `GET(Streaming)` dans l'option Type de requête.	Nombre