Connector Builder documentation de soumission

Chaque connecteur Workflows Okta nécessite une documentation de l'utilisateur, et celle-ci doit être incluse dans la soumission du connecteur. Le Okta Integration Network analyse votre documentation dans le cadre du processus de vérification .

Une fois votre connecteur publié et mis à disposition dans Workflows Okta, vous pouvez définir le niveau d'accès pour votre documentation :

• Général : n'importe quelle personne peut consulter votre contenu.

• Client uniquement : si vous souhaitez que les documents relatifs au connecteur restent privés, configurez une méthode de connexion sur votre site afin que seuls les clients approuvés y aient accès.

Exigences

Votre contenu doit couvrir les domaines suivants :

• Comment configurer et utiliser votre connecteur

• Comprendre les champs de saisie et de résultat des cartes d'action de votre connecteur

• Comment anticiper et résoudre les problèmes de performance pour les flux contenant une ou plusieurs de vos cartes d'action

Lorsqu'un utilisateur clique sur l'icône d'aide d'une carte de connecteur ou d'une boîte de dialogue, une fenêtre contextuelle affiche un lien vers la documentation d'aide hébergée en externe.

La documentation utilisateur relative à votre connecteur peut se présenter dans n'importe quel format, mais en général, vous devez utiliser l'un des formats suivants : HTML, Google Docs, document Microsoft Word ou PDF.

Votre documentation doit inclure les rubriques suivantes :

• Autorisation
• Rubriques d'aide pour chaque carte d'action
• Une rubrique d'aide pour toute carte Action d'API personnalisée
• En option, des rubriques d'aide au dépannage des problèmes, des FAQ ou d'autres conseils relatifs à votre connecteur et à ses cartes.

Étapes suivantes

Connector Builder documentation d'autorisation

Connector Builder documentation sur les cartes d'action

Connector Builder documentation sur les cartes d'API personnalisée