Gestion des clés d'accès

Une clé d'accès est un jeton que vous devez utiliser pour configurer les agents afin qu'ils puissent transmettre correctement les données à votre instance d' Workload Protection sur IBM Cloud.

Gestion des clés d'accès à l'aide de la console

Vous pouvez consulter, créer, désactiver, activer et supprimer des clés d'accès pour une instance d' Workload Protection à l'aide de la console IBM Cloud.

Pour gérer les clés d'accès à l'aide de la console, procédez comme suit :

  1. Dans la console d' IBM Cloud, cliquez sur l'icône du menu de navigation > Sécurité > Conformité.
  2. Cliquez sur le nom de votre instance d' Workload Protection.
  3. Dans le menu Actions, sélectionnez « Gérer la clé ».
  4. Cliquez sur votre tableau de bord pour afficher, créer, désactiver, activer ou supprimer des clés d'accès.

Vous pouvez également masquer la clé d'accès aux utilisateurs qui ne sont pas administrateurs. Pour plus d'informations, consultez la rubrique « Utilisateurs non administrateurs ».

Obtenir la clé d'accès via l'interface de ligne de commande (CLI)

Pour obtenir la clé d'accès d'une instance d' Workload Protection à l'aide de l'interface de ligne de commande (CLI), procédez comme suit :

  1. Installez l'interface de ligne de commande IBM Cloud.

  2. Connectez-vous à la région qui héberge votre instance d' Workload Protection en exécutant la ibmcloud login commande suivante :

    ibmcloud login
    
  3. Définissez le groupe de ressources dans lequel l'instance s'exécute en exécutant la ibmcloud target commande suivante :

    ibmcloud target -g <resource_group>
    

    Où « <resource_group> » correspond au nom du groupe de ressources. Le groupe de ressources default est sélectionné par défaut.

  4. Pour obtenir le nom de l'instance, exécutez la ibmcloud resource service-instances commande suivante :

    ibmcloud resource service-instances
    
  5. Pour obtenir le nom de la clé API associée à l'instance, exécutez la ibmcloud resource service-keys commande suivante :

    ibmcloud resource service-keys --instance-name <instance_name> --output JSON
    

    Où « <instance_name> » correspond au nom de l'instance que vous avez obtenu à l'étape précédente.

    La sortie de cette commande comprend le champ « Sysdig Access Key », qui contient la clé d'accès de l'instance.

Vous pouvez également créer, supprimer, activer ou désactiver des clés d'accès à l'aide de l'API ou de la console. Pour consulter les étapes à suivre, accédez à la documentation de l'API ou rendez-vous dans la section « Gestion des clés d'accès à l'aide de la console ».

Obtenir la clé d'accès via l'API

Vous pouvez obtenir la clé d'accès via l'interface de ligne de commande (CLI) ou la console. Pour consulter les étapes à suivre, passez aux instructions de l'interface en ligne de commande (CLI) ou de l'interface utilisateur (UI). Vous pouvez également utiliser l'API pour récupérer toutes les clés d'accès disponibles. Pour plus d'informations, consultez la section « Affichage des clés d'accès disponibles à l'aide de l'API ».

Création d'une clé d'accès à l'aide de l'API

Si la clé d'accès est compromise ou que vous disposez d'une règle permettant de la renouveler au bout d'un certain nombre de jours, vous pouvez générer une nouvelle clé d'accès et désactiver l'ancienne.

Pour créer une clé d'accès pour une instance Workload Protection, procédez comme suit :

  1. Copiez le jeton API depuis l'interface utilisateur d' Workload Protection. Pour plus d'informations, consultez la section « Récupérer le jeton API Sysdig ».

  2. Envoyez une requête POST via curl vers le point de terminaison pour générer une nouvelle clé d'accès :

    curl -X POST -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys
    

    Où :

    • ENDPOINT Il s'agit de l' URL e de la région dans laquelle l'instance est disponible. Pour plus d'informations, consultez la section « Endpoints ».
    • SYSDIG_API_TOKEN Il s'agit du jeton API que vous avez obtenu à l'étape 1.
    • GUID est l'identificateur global unique de l'instance associée à la clé d'accès.

    Exemple :

    curl -X POST -H 'Authorization: Bearer xxxxxxx' -H 'IBMInstanceID: 12345678-1234-1234-1234-123456789012' https://us-east.security-compliance-secure.cloud.ibm.com/api/customer/accessKeys
    

    La sortie fournit la clé d'accès générée dans la réponse :

    {
        "customerAccessKey": {
            "enabled": true,
            "accessKey": "12345678-1234-1234-1234-123456789012",
            "dateCreated": 1573852152224,
            "dateDisabled": null,
            "limit": null,
            "reservation": null,
            "teamId": null
        }
    }
    

    Vous pouvez désormais utiliser la clé d'accès pour configurer les agents.

Désactivation d'une touche d'accès à l'aide de l'API

Pour désactiver une clé d'accès existante pour une instance Workload Protection, procédez comme suit :

  1. Copiez le jeton API depuis l'interface utilisateur d' Workload Protection. Pour plus d'informations, consultez la section « Récupérer le jeton API Sysdig ».

  2. Envoyez une requête POST via curl vers le point de terminaison pour désactiver la clé d'accès :

    curl -X POST -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY/disable
    

    Où :

    • ENDPOINT Il s'agit de l' URL e de la région dans laquelle l'instance est disponible.
    • SYSDIG_API_TOKEN Il s'agit du jeton API que vous avez obtenu à l'étape 1.
    • ACCESS_KEY est la touche d'accès que vous souhaitez désactiver.
    • GUID est l'identificateur global unique de l'instance associée à la clé d'accès.

    Une fois la clé d'accès désactivée, les agents connectés à cette clé ne pourront plus envoyer de métriques à cette instance d' Workload Protection.

    Exemple :

    curl -X POST -H 'Authorization: Bearer xxxxxxx' -H 'IBMInstanceID: 12345678-1234-1234-1234-123456789012' https://us-east.security-compliance-secure.cloud.ibm.com/api/customer/accessKeys/b302311f-aa1c-4930-8726-59fb4ba0fe84/disable
    

    La sortie fournit la clé d'accès pour les personnes en situation de handicap dans la réponse :

    {
        "customerAccessKey": {
            "enabled": false,
            "accessKey": "12345678-1234-1234-1234-123456789012",
            "dateCreated": 1573852152224,
            "dateDisabled": 1683550789329,
            "limit": null,
            "reservation": null,
            "teamId": null
        }
    }
    

Activation d'une clé d'accès via l'API

Pour activer une clé d'accès existante pour une instance Workload Protection, procédez comme suit :

  1. Copiez le jeton API depuis l'interface utilisateur d' Workload Protection. Pour plus d'informations, consultez la section « Récupérer le jeton API Sysdig ».

  2. Envoyez une requête POST via curl vers le point de terminaison pour activer la clé d'accès :

    curl -X POST -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY/enable
    

    Où :

    • ENDPOINT Il s'agit de l' URL e de la région dans laquelle l'instance est disponible.
    • SYSDIG_API_TOKEN Il s'agit du jeton API que vous avez obtenu à l'étape 1.
    • ACCESS_KEY est la touche d'accès que vous souhaitez activer.
    • GUID est l'identificateur global unique de l'instance associée à la clé d'accès.

Une fois la clé d'accès activée, vous devez redémarrer manuellement les agents, car tout agent qui se connecte avec une clé d'accès désactivée est interrompu.

Affichage des clés d'accès disponibles à l'aide de l'API

Pour afficher toutes les clés d'accès d'une instance Workload Protection, procédez comme suit :

  1. Copiez le jeton API depuis l'interface utilisateur d' Workload Protection. Pour plus d'informations, consultez la section « Récupérer le jeton API Sysdig ».

  2. Envoyez une requête GET via curl vers le point de terminaison régional pour afficher les clés d'accès :

    curl -X GET -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys
    

    Où :

    • ENDPOINT Il s'agit de l' URL e de la région dans laquelle l'instance est disponible. Pour plus d'informations, consultez la section « Endpoints ».
    • SYSDIG_API_TOKEN Il s'agit du jeton API que vous avez obtenu à l'étape 1.
    • GUID est l'identificateur global unique de l'instance associée à la clé d'accès.

    La sortie affiche la liste des touches d'accès et indique si elles sont activées :

    {
        "customerAccessKeys": [
            {
                "enabled": true,
                "accessKey": "12345678-1234-1234-1234-123456789012",
                "dateCreated": 1541096409000,
                "dateDisabled": null,
                "limit": null,
                "reservation": null,
                "teamId": null
            },
            {
                "enabled": false,
                "accessKey": "87654321-1234-1234-1234-123456789012",
                "dateCreated": 1573849361000,
                "dateDisabled": 1573849367000,
                "limit": null,
                "reservation": null,
                "teamId": null
            }
        ]
    }
    

Suppression de clés d'accès à l'aide de l'API

Pour supprimer une clé d'accès d'une instance d' Workload Protection, procédez comme suit :

  1. Copiez le jeton API depuis l'interface utilisateur d' Workload Protection. Pour plus d'informations, consultez la section « Récupérer le jeton API Sysdig ».

  2. Envoyez une requête curl DELETE vers le point de terminaison régional pour supprimer la clé d'accès :

    curl -X DELETE -H 'Authorization: Bearer SYSDIG_API_TOKEN' -H 'IBMInstanceID: GUID' https://ENDPOINT/api/customer/accessKeys/ACCESS_KEY
    

    Où :

    • ENDPOINT Il s'agit de l' URL e de la région dans laquelle l'instance est disponible.
    • SYSDIG_API_TOKEN Il s'agit du jeton API que vous avez obtenu à l'étape 1.
    • GUID est l'identificateur global unique de l'instance associée à la clé d'accès.
    • ACCESS_KEY est la clé d'accès à supprimer. Vous pouvez afficher une liste de toutes les clés d'accès pour obtenir les valeurs de clé d'accès.