Créer un client API

Introduction

Dans ce guide, vous apprendrez à créer une définition de client API dans l'interface d'administration IBM Security Verify.

Un client d'API privilégié est nécessaire lorsqu'une application doit accéder à des API protégées par OAuth sans l'autorité déléguée d'un utilisateur final. Un client privilégié de l'API utilise le flux d'octroi des informations d'identification du client OAuth pour obtenir un jeton d'accès.

Les API d'IBM Security Verify sont protégées par OAuth et la création d'un client API permet à une application d'obtenir l'autorisation d'appeler des fonctions privilégiées d'IBM Security Verify. Les autorisations spécifiques accordées à un client de l'API sont définies dans le cadre de la définition du client.

Prérequis

Il n'y a pas de conditions préalables à la création d'un client API autonome. Si vous souhaitez créer un client API associé à une application personnalisée, cette définition d'application doit déjà exister.

Choisir l'endroit où créer la définition du client API

Un client API privilégié peut être défini comme un client autonome ou dans le cadre d'une définition d'application personnalisée.

Si le client API est nécessaire pour une application qui n'a pas besoin d'une définition d'application (parce qu'elle ne nécessite qu'un accès privilégié à l'API), il doit être configuré comme un client autonome.

Si le client de l'API est nécessaire pour une application personnalisée qui a également besoin d'une définition d'application (pour prendre en charge l'authentification unique ou d'autres flux OAuth), il est logique de définir le client de l'API dans cette définition d'application.

Option 1 - Client API autonome

Dans l'interface d'administration, accédez à la page Sécurité > Accès API et cliquez sur le bouton Ajouter un client API.

Option 2 - Client de l'API de l'application

Dans l'interface d'administration, accédez à la page Applications > Applications et modifiez l'application personnalisée qui a besoin du client API privilégié. Dans la définition de l'application, sélectionnez l'onglet API access et cliquez sur le bouton Add API client.

Définir le client de l'API

Habilitations

C'est ici que vous accordez les autorisations nécessaires à l'application qui utilise ce client API.

Les autorisations courantes pour une application d'authentification personnalisée sont les suivantes :

• Authentifier un utilisateur
• Lire les utilisateurs et les groupes
• Lire l'inscription à l'authentification à deux facteurs pour tous les utilisateurs

Les autorisations courantes pour une application d'enregistrement personnalisée sont les suivantes :

• Authentifier un utilisateur
• Gérer les utilisateurs et les groupes standard
• Gérer l'inscription à l'authentification à deux facteurs pour tous les utilisateurs

📘

Permissions de lecture ou de gestion

De nombreuses autorisations ont des variantes de lecture et de gestion. Dans la plupart des cas, les clients qui bénéficient de l'autorisation de gestion sont également en mesure d'effectuer des actions de lecture sans que cette autorisation leur soit spécifiquement accordée.

Portées personnalisées

Par défaut, un client de l'API peut demander n'importe quel champ d'application. Si vous souhaitez restreindre les portées que le client peut demander, cochez la case Autoriser uniquement les portées configurées et ajoutez les portées que vous souhaitez autoriser.

Les champs d'application ne sont pertinents pour un client d'API privilégié que s'il est utilisé pour appeler des API personnalisées. Les champs d'application ne sont pas utilisés pour accorder une autorisation aux API IBM Security Verify.

Filtre IP

Par défaut, un client de l'API peut demander un jeton d'accès à partir de n'importe quelle adresse IP. Si vous souhaitez limiter les adresses IP valides pour ce client API, cochez la case Activer le filtrage IP et saisissez le filtre d'adresses IP requis.

Propriétés supplémentaires

Vous pouvez attribuer des attributs personnalisés à un client API. Ils peuvent être utilisés pour stocker des propriétés liées au client de l'API. Ces valeurs ne sont pas utilisées par IBM Security Verify mais peuvent être consultées via l'API pour obtenir des informations sur le client de l'API.

Nom et description

Le nom et la description du client API sont lisibles par l'homme et ne sont utilisés que pour l'administration et l'établissement de rapports.

Obtenir les informations d'identification du client

Les informations d'identification du client (identifiant et secret du client) sont générées lorsque la définition du client de l'API est enregistrée pour la première fois.

Après avoir enregistré la définition du client, sélectionnez les trois points sur la tuile du client et sélectionnez Détails de la connexion dans le menu d'action. Les valeurs de l'identifiant et du secret du client sont affichées sur la page des détails de la connexion. Vous pouvez utiliser le bouton copier de chaque élément pour l'ajouter à votre tampon de collage.