Skip to main content
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Présentation de l'API de gestion des locataires

Contributeurs
PDF

Vous pouvez effectuer des tâches de gestion du système via l'API REST de gestion des locataires plutôt que dans l'interface utilisateur du gestionnaire de locataires. Par exemple, vous pouvez utiliser l'API pour automatiser les opérations ou créer plusieurs entités plus rapidement (par exemple, les utilisateurs).

L'API de gestion des locataires utilise la plateforme d'API open source swagger. Swagger fournit une interface utilisateur intuitive qui permet aux développeurs et aux non-développeurs d'interagir avec l'API. L'interface utilisateur swagger fournit des détails complets et de la documentation pour chaque opération API.

Pour accéder à la documentation de swagger pour l'API de gestion des locataires :

Étapes

  1. Connectez-vous au Gestionnaire de locataires.

  2. Sélectionnez aide > Documentation API dans l'en-tête Gestionnaire de locataires.

Opérations d'API

L'API de gestion des locataires organise les opérations API disponibles dans les sections suivantes :

  • Compte — opérations sur le compte de locataire actuel, y compris l'obtention des informations sur l'utilisation du stockage.

  • Auth — opérations pour effectuer l'authentification de session utilisateur.

    L'API de gestion des locataires prend en charge le schéma d'authentification par jeton Bearer. Pour une connexion locataire, vous fournissez un nom d'utilisateur, un mot de passe et un ID de compte dans le corps JSON de la demande d'authentification (c'est-à-dire, POST /api/v3/authorize). Si l'utilisateur est authentifié, un jeton de sécurité est renvoyé. Ce token doit être fourni dans l'en-tête des requêtes API suivantes (« autorisation : jeton porteur »).

    Voir « protection contre la contrefaçon de demandes intersites » pour des informations sur l'amélioration de la sécurité de l'authentification.

    Remarque Si l'authentification unique (SSO) est activée pour le système StorageGRID, vous devez effectuer différentes étapes pour l'authentification. Consultez la section « authentification dans l'API si l'authentification unique est activée » dans les instructions d'administration de StorageGRID.

  • Config — opérations liées à la version du produit et aux versions de l'API tenant Management. Vous pouvez lister la version du produit ainsi que les versions principales de l'API prises en charge par cette version.

  • Conteneurs — opérations sur des compartiments S3 ou des conteneurs Swift, comme suit :

    Protocole L'autorisation permet

    S3

    • Création de compartiments conformes et non conformes

    • Modification des paramètres de conformité hérités

    • Définition du contrôle de cohérence pour les opérations effectuées sur les objets

    • Création, mise à jour et suppression de la configuration CORS d'un compartiment

    • Activation et désactivation des mises à jour de l'heure du dernier accès des objets

    • Gestion des paramètres de configuration des services de plateforme, y compris la réplication CloudMirror, les notifications et l'intégration de la recherche (notification-métadonnées)

    • Suppression de compartiments vides

    SWIFT

    Définition du niveau de cohérence utilisé pour les conteneurs

  • DESACTIVE-fonctions — opérations pour afficher les fonctions qui pourraient avoir été désactivées.

  • Noeuds finaux — opérations pour gérer un noeud final. Les terminaux permettent à un compartiment S3 d'utiliser un service externe pour la réplication StorageGRID CloudMirror, les notifications ou l'intégration de la recherche.

  • Groupes — opérations pour gérer des groupes de locataires locaux et extraire des groupes de locataires fédérés à partir d'un référentiel d'identité externe.

  • Identity-source — opérations pour configurer un référentiel d'identité externe et synchroniser manuellement les informations de groupe et d'utilisateur fédérés.

  • Régions — opérations pour déterminer les régions qui ont été configurées pour le système StorageGRID.

  • s3 — opérations pour gérer les clés d'accès S3 pour les utilisateurs locataires.

  • s3-Object-lock — opérations pour déterminer comment le verrouillage d'objet S3 global (conformité) est configuré pour le système StorageGRID.

  • Utilisateurs — opérations pour afficher et gérer les utilisateurs locataires.

Détails de l'opération

Lorsque vous développez chaque opération d'API, vous pouvez voir son action HTTP, son URL de point final, une liste de tous les paramètres obligatoires ou facultatifs, un exemple du corps de la demande (si nécessaire) et les réponses possibles.

Exemple d'opération D'OBTENTION de groupes dans l'API swagger

Émission de requêtes API

Important Toutes les opérations d'API que vous effectuez à l'aide de la page Web API Docs sont des opérations en direct. Veillez à ne pas créer, mettre à jour ou supprimer des données de configuration ou d'autres données par erreur.
Étapes

  1. Cliquez sur l'action HTTP pour afficher les détails de la demande.

  2. Déterminez si la demande nécessite des paramètres supplémentaires, tels qu'un ID de groupe ou d'utilisateur. Ensuite, obtenir ces valeurs. Vous devrez peut-être d'abord lancer une autre demande d'API pour obtenir les informations dont vous avez besoin.

  3. Déterminez si vous devez modifier l'exemple de corps de la demande. Si c'est le cas, vous pouvez cliquer sur modèle pour connaître les exigences de chaque champ.

  4. Cliquez sur essayez-le.

  5. Fournir tous les paramètres requis ou modifier le corps de la demande selon les besoins.

  6. Cliquez sur Exécuter.

  7. Vérifiez le code de réponse pour déterminer si la demande a réussi.

Informations associées

"Protection contre la contrefaçon de demandes intersites (CSRF)"

"Administrer StorageGRID"