Créer une politique d’accès REST API

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 2 minutes de lecture

    • Créez une politique d’accès API et mappez un profil d’authentification pour restreindre le type d’authentification pour une API REST. Par exemple, vous pouvez créer une politique d’accès API qui autorise uniquement l’authentification par jeton d’ID pour une API REST.

    Avant de commencer

    Procédure

    1. Accédez à la Tous > Services web du système > Politiques d'accès REST API.
    2. Cliquez sur Nouveau.
    3. Renseignez les champs du formulaire.
      Champs de la politique d’accès API
      Tableau 1. Politiques d'accès API
      Champ Description
      Nom Nom unique de la politique d’accès de l’API.
      Actif Option permettant d’activer la politique d’accès API.
      API REST L’API REST à laquelle la politique d’accès est appliquée. Par exemple, API de pièce jointe.
      CHEMIN REST API Chemin d’accès de l’API de REST. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée. Par exemple, now/attachment.
      Méthode HTTP Méthode utilisée pour interagir avec l’API. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée.
      Version Version de l'API. Par exemple, v1. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée.
      Remarque :
      Si vous souhaitez créer une politique d’authentification pour toutes les versions d’une REST API, vous devez créer des politiques individuelles pour chaque version.
      Ressources Ressource enfant de l’API REST. Ce champ est automatiquement renseigné en fonction de l’API REST sélectionnée. Par exemple, /now/attachment
      Application Périmètre de l'application.
      Global Activez cette option pour appliquer la politique d’authentification à toutes les méthodes, versions et ressources de l’API.
      Appliquer à toutes les méthodes Activez cette option pour appliquer la politique d’authentification de l’API à l’ensemble des méthodes, versions et ressources de l’API.
      Appliquer à toutes les ressources Activez cette option pour appliquer la politique d’authentification de l’API à toutes les versions.
      Appliquer à toutes les versions Activez cette option pour appliquer la politique d’authentification de l’API à toutes les ressources.
      Remarque :
      Pour en savoir plus sur la priorisation de la politique d’accès API, reportez-vous à la section Priorisation de la politique d’accès API.
    4. Double-cliquez sur Insérer une nouvelle ligne.
    5. Sélectionnez un profil d’authentification entrant dans la liste et cliquez sur l’icône Enregistrer icône Enregistrer.
      Par exemple, vous pouvez ajouter l’authentification de base, le jeton d’ID, l’authentification basée sur certificat, l’authentification OAuth ou l’authentification WSSE.
      1. Pour ajouter un ou plusieurs profils d’authentification entrants, cliquez sur Nouveau pour créer un nouveau profil.
      2. Choisissez Quels types de profils d’authentification ?.
        • Créer des profils d'authentification http standard
        • Créer des profils d'authentification WSSE
        Profil d’authentification
      3. Après avoir créé le profil d’authentification, sauvegardez l’enregistrement.
    6. Cliquez sur Envoyer pour soumettre la politique d’accès à l’API REST.