Retour brut

Cette carte de fonction renvoie des données à l'appelant. Il s'agit d'une version avancée de la carte de fonction Retour, mais qui vous donne un contrôle total sur la réponse HTTP.

Avec cette carte de fonction, vous pouvez effectuer les opérations suivantes :

Produire une API qui renvoie du XML	Utilisez la carte de fonction Construction pour créer une chaîne XML contenant votre réponse. Glissez la sortie vers l'entrée body d'une carte Retour brut.
Produire une API qui renvoie une liste JSON	Utilisez la carte de fonction Convertir en chaîne pour créer une représentation de chaîne JSON de votre réponse de liste. Glissez la sortie vers l'entrée body d'une carte Retour brut.
Produire une API qui renvoie un objet avec des clés dynamiques	La carte de fonction Retour exige que vous définissiez les clés de votre réponse au moment de la conception. Au lieu de cela, la carte de fonction Retour brut vous permet d'utiliser les cartes de fonction Objet pour générer un objet de réponse, par exemple : Utilisez la carte de fonction Convertir en chaîne pour créer une version de chaîne JSON de l'objet. Glissez la sortie vers l'entrée body d'une carte Retour brut.
Définir le code de statut HTTP pour la réponse	La carte de fonction de Retour renvoie toujours un code de réponse HTTP 200. Vous pouvez utiliser la carte Retour brut pour définir le code de statut HTTP sur n'importe quelle valeur valide, par exemple, `200` ou de `400` à `599`.
Définir les en-têtes HTTP de la réponse	Utilisez les cartes de fonction Objet pour créer un objet représentant tout en-tête HTTP dont vous avez besoin. Par exemple, si l'objet des en-têtes est `{ "Content-Type": "application/xml" }`, alors la chaîne d'en-tête pour la réponse est `"Content-Type: application/xml"`. Workflows Okta fusionne ces en-têtes avec ceux produits par le service API.

Entrée

Champ	Définition	Type	Obligatoire
Code de statut	Un code de statut à retourner à l'appelant. Les valeurs valides sont `200` ou tout autre code de réponse HTTP de `400` à `599`.	Nombre	FALSE
en-têtes	Un objet représentant les en-têtes de la réponse. Chaque clé de l'en-tête est analysée en une chaîne d'en-tête sous forme d'une entrée `"key: value"`. Par exemple, `"Content-Type: text/plain"`.	Objet	FALSE
body	Le corps de la réponse HTTP.	Texte	FALSE

Sortie

Cette carte n'a pas de champ de sortie.

Remarque :

Cette carte fonction se comporte différemment lorsqu'elle est placée à l'intérieur d'un bloc Si/SinonSi ou Si/Erreur.

Considérez ces blocs comme représentant des flux d'aide anonymes. De la même manière que lorsque vous appelez un flux d'aide, cette carte de fonction vous renvoie au parent. Le fait de placer cette carte fonction à l'intérieur de l'un de ces blocs vous envoie à l'étape immédiatement après le conteneur.

Utilisez une fonction Continuer si après le bloc Si/SinonSi pour arrêter un flux dans des conditions normales. Vous pouvez plutôt utiliser une carte Retourner une erreur ou Retourner une erreur si, mais ces options génèrent une erreur lorsque le flux s'arrête.