Création d'une clé d'API pour un ID de service

Créez une clé d'API à associer à un ID de service dans la console :

1. Dans la console IBM Cloud, cliquez sur Gérer > Accès (IAM), puis sélectionnez ID de service.
2. Si vous ne possédez pas d'ID de service, créez-en un.
3. Cliquez sur l'icône Actions > Gérer l'ID service.
4. Cliquez sur Clés d'API.
5. Cliquez sur Créer.
6. Ajoutez un nom et une description permettant d'identifier facilement la clé d'API.
7. Cliquez sur Créer.
8. Sauvegardez votre clé d'API en la copiant ou en la téléchargeant vers un emplacement sécurisé.

Pour des raisons de sécurité, la clé d'API ne peut être copiée ou téléchargée qu'au moment de sa création. Si la clé d'API est perdue, vous devez en créer une autre.

Mise à jour d'une clé API pour un identifiant de service à l'aide de la console

Vous pouvez mettre à jour une clé d'API en éditant le nom ou la description utilisés pour l'identifier dans l'interface utilisateur.

1. Dans la console IBM Cloud, cliquez sur Gérer > Accès (IAM), puis sélectionnez ID de service.
2. Cliquez sur l'icône Actions > Gérer l'ID service.
3. Cliquez sur Clés d'API.
4. Cliquez sur l'icône Actions > Éditer le nom et la description.

Si vous n'avez pas créé l'ID de service et que vous êtes le propriétaire de compte ou un administrateur du service d'identité IAM, vous pouvez mettre à jour des clés d'API pour n'importe quel ID de service du compte. Accédez à la page Clés d'API et sélectionnez l'option Toutes les clés d'API d'ID de service dans le menu Afficher pour rechercher la clé d'API que vous souhaitez gérer.

Création d'une clé d'API pour un ID de service à l'aide de l'interface de ligne de commande

Pour créer une clé d'API pour un ID de service à l'aide de l'interface de ligne de commande, vous pouvez utiliser la commande ibmcloud iam service-api-key-create.

ibmcloud iam service-api-key-create NAME (SERVICE_ID_NAME|SERVICE_ID_UUID) [-d, --description DESCRIPTION] [--file FILE] [-f, --force] [--lock]

Mise à jour d'une clé d'API pour un ID de service à l'aide de l'interface de ligne de commande

Pour mettre à jour une clé d'API pour un ID de service à l'aide de l'interface de ligne de commande, vous pouvez utiliser la commande ibmcloud iam service-api-key-update.

ibmcloud iam service-api-key-update NAME SERVICE_ID [-n, --name NEW_sNAME] [-d, --description DESCRIPTION] [-v, --version VERSION] [-f, --force]

Verrouillage d'une clé d'API d'un ID de service

Vous pouvez empêcher la suppression des clés d'API représentant l'identité de l'ID de service en les verrouillant. Une clé d'API verrouillée est indiquée par l'icône Verrouillé dans l'interface utilisateur.

1. Dans la console IBM Cloud, cliquez sur Gérer > Accès (IAM) puis sélectionnez ID de service.
2. Identifiez la ligne de l'ID de service pour lequel vous souhaitez sélectionner une clé d'API puis sélectionnez le nom de l'ID de service.
3. Cliquez sur Clés d'API.
4. Survolez la ligne de la clé d'API que vous souhaitez verrouiller, puis cliquez sur l'icône Actions pour ouvrir une liste d'options.
5. Cliquez sur Verrouiller la clé d'API.

Vous pouvez verrouiller votre clé d'API à tout moment pour mettre à jour, supprimer ou ajouter une règle d'accès ou pour retirer la clé d'API.

Verrouillage ou déverrouillage d'une clé d'API d'ID de service à l'aide de l'interface de ligne de commande

Vous pouvez empêcher la suppression des clés d'API représentant l'identité de l'ID de service en les verrouillant. Une clé d'API verrouillée est indiquée par l'icône Verrouillé dans l'interface utilisateur. Pour verrouiller une clé d'API d'ID de service, utilisez la commande suivante :

ibmcloud iam service-api-key-lock (APIKEY_NAME|APIKEY_UUID) (SERVICE_ID_NAME|SERVICE_ID_UUID) [-f, --force]

Prérequis

Point final, Connexion, Cible

Options de commande :

APIKEY_NAME (obligatoire)

Nom de la clé d'API, exclut APIKEY_UUID

APIKEY_UUID (obligatoire)

Identificateur unique universel de la clé d'API, exclut APIKEY_NAME

SERVICE_ID_NAME (obligatoire)

Nom de l'ID de service, exclut SERVICE_ID_UUID

SERVICE_ID_UUID (obligatoire)

Identificateur unique universel de l'ID de service, exclut SERVICE_ID_NAME

-f, --force

Verrouiller sans confirmation

Exemples :

Verrouiller la clé d'API de service sample-key de l'ID de service sample-service :

ibmcloud iam service-api-key-lock sample-key sample-service

Pour déverrouiller une clé d'API d'ID de service, utilisez la commande suivante :

ibmcloud iam service-api-key-unlock (APIKEY_NAME|APIKEY_UUID) (SERVICE_ID_NAME|SERVICE_ID_UUID) [-f, --force]

Suppression d'une clé d'API pour un ID de service

Vous pouvez supprimer une clé d'API associée à un ID de service. Cela dit, si vous supprimez une clé d'API qui est utilisée par une application, celle-ci ne pourra plus s'authentifier auprès de vos services.

1. Dans la console IBM Cloud, cliquez sur Gérer > Accès (IAM), puis sélectionnez ID de service.
2. Si vous ne possédez pas d'ID de service, créez-en un.
3. Cliquez sur l'icône Actions > Gérer l'ID service.
4. Cliquez sur Clés d'API.
5. Cliquez sur l'icône Actions > Supprimer.

Si vous n'avez pas créé l'ID de service et que vous êtes le propriétaire de compte ou un administrateur du service d'identité IAM, vous pouvez supprimer des clés d'API pour n'importe quel ID de service du compte. Accédez à la page Clés d'API et sélectionnez l'option Toutes les clés d'API d'ID de service dans le menu Afficher pour rechercher la clé d'API que vous souhaitez gérer.

Suppression d'une clé d'API pour un ID de service à l'aide de l'interface de ligne de commande

Vous pouvez supprimer une clé d'API associée à un ID de service. Cela dit, si vous supprimez une clé d'API qui est utilisée par une application, celle-ci ne pourra plus s'authentifier auprès de vos services. Pour supprimer une clé d'API pour un ID de service à l'aide de l'interface de ligne de commande, vous pouvez utiliser la commande ibmcloud iam service-api-key-delete.

ibmcloud iam service-api-key-delete NAME SERVICE_ID [-f, --force]

Création d'une clé d'API pour un ID de service à l'aide de l'API

Pour créer une clé API d'identification de service, appelez l'API IAM Identity Service comme indiqué dans l'exemple suivant.

curl -X POST 'https://iam.cloud.ibm.com/v1/apikeys' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json' -d '{
  "name": "Service-apikey",
  "description": "my service key",
  "iam_id": "IBMid-123WEREW",
  "account_id": "ACCOUNT_ID"
  "store_value": false
}'

CreateApiKeyOptions createApiKeyOptions = new CreateApiKeyOptions.Builder()
    .name(apiKeyName)
    .iamId(iamId)
    .description("Example ApiKey")
    .build();

Response<ApiKey> response = service.createApiKey(createApiKeyOptions).execute();
ApiKey apiKey = response.getResult();
apikeyId = apiKey.getId();
System.out.println(apiKey.toString());

const params = {
  name: apikeyName,
  iamId: iamId,
  description: 'Example ApiKey',
};

iamIdentityService.createApiKey(params)
  .then(res => {
    apikeyId = res.result.id
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err);
  });

api_key = iam_identity_service.create_api_key(
  name=apikey_name,
  iam_id=iam_id
).get_result()

apikey_id = api_key['id']

print(json.dumps(api_key, indent=2))

createAPIKeyOptions := iamIdentityService.NewCreateAPIKeyOptions(apikeyName, iamID)
createAPIKeyOptions.SetDescription("Example ApiKey")

apiKey, response, err := iamIdentityService.CreateAPIKey(createAPIKeyOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(apiKey, "", "  ")
fmt.Println(string(b))
apikeyID = *apiKey.ID

Mise à jour d'une clé d'API pour un ID de service à l'aide de l'API

Pour modifier une clé API pour un identifiant de service à l'aide de l'API, appelez l'API IAM Identity Service comme indiqué dans l'exemple suivant :

curl -X PUT 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID' -H 'Authorization: Bearer TOKEN' -H 'If-Match: <value of etag header from GET request>' -H 'Content-Type: application/json' -d '{
  "name": "Service-apikey",
  "description": "my service key"
}'

UpdateApiKeyOptions updateApiKeyOptions = new UpdateApiKeyOptions.Builder()
    .id(apikeyId)
    .ifMatch(apikeyEtag)
    .description("This is an updated description")
    .build();

Response<ApiKey> response = service.updateApiKey(updateApiKeyOptions).execute();
ApiKey apiKey = response.getResult();
System.out.println(apiKey.toString());

const params = {
  id: apikeyId,
  ifMatch: apikeyEtag,
  description: 'This is an updated description',
};

iamIdentityService.updateApiKey(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err);
  });

api_key = iam_identity_service.update_api_key(
  id=apikey_id,
  if_match=apikey_etag,
  description='This is an updated description'
).get_result()

print(json.dumps(api_key, indent=2))

updateAPIKeyOptions := iamIdentityService.NewUpdateAPIKeyOptions(apikeyID, apikeyEtag)
updateAPIKeyOptions.SetDescription("This is an updated description")

apiKey, response, err := iamIdentityService.UpdateAPIKey(updateAPIKeyOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(apiKey, "", "  ")
fmt.Println(string(b))

Verrouillage et déverrouillage d'une clé d'API pour un ID de service à l'aide de l'API

Vous pouvez empêcher la suppression des clés d'API représentant l'identité de l'ID de service en les verrouillant.

curl -X POST 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID/lock' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'

LockApiKeyOptions lockApiKeyOptions = new LockApiKeyOptions.Builder()
    .id(apikeyId)
    .build();

service.lockApiKey(lockApiKeyOptions).execute();

const params = {
  id: apikeyId,
};

iamIdentityService.lockApiKey(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err);
  });

response = iam_identity_service.lock_api_key(id=apikey_id)

print(response)

lockAPIKeyOptions := iamIdentityService.NewLockAPIKeyOptions(apikeyID)

response, err := iamIdentityService.LockAPIKey(lockAPIKeyOptions)
if err != nil {
  panic(err)
}

curl -X DELETE 'https://iam.cloud.ibm.com/v1/serviceids/SERVICE_ID_UNIQUE_ID/lock' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'

UnlockServiceIdOptions unlockServiceIdOptions = new UnlockServiceIdOptions.Builder()
    .id(svcId)
    .build();

service.unlockServiceId(unlockServiceIdOptions).execute();

const params = {
  id: svcId,
};

iamIdentityService.unlockServiceId(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err);
    done(err);
  });

response = iam_identity_service.unlock_service_id(id=svc_id)

print(response)

unlockServiceIDOptions := iamIdentityService.NewUnlockServiceIDOptions(svcID)

response, err := iamIdentityService.UnlockServiceID(unlockServiceIDOptions)
if err != nil {
  panic(err)
}

Suppression d'une clé d'API pour un ID de service à l'aide de l'API

Pour supprimer une clé API par pour un identifiant de service à l'aide de l'API, appelez l'API IAM Identity Service comme indiqué dans l'exemple suivant :

curl -X DELETE 'https://iam.cloud.ibm.com/v1/apikeys/APIKEY_UNIQUE_ID' -H 'Authorization: Bearer TOKEN' -H 'Content-Type: application/json'

DeleteApiKeyOptions deleteApiKeyOptions = new DeleteApiKeyOptions.Builder()
    .id(apikeyId)
    .build();

service.deleteApiKey(deleteApiKeyOptions).execute();

const params = {
  id: apikeyId,
};

iamIdentityService.deleteApiKey(params)
  .then(res => {
    console.log(JSON.stringify(res.result, null, 2));
  })
  .catch(err => {
    console.warn(err);
  });

delete_api_key(self,
        id: str,
        **kwargs
    ) -> DetailedResponse

response = iam_identity_service.delete_api_key(id=apikey_id)

print(response)

deleteAPIKeyOptions := iamIdentityService.NewDeleteAPIKeyOptions(apikeyID)

response, err := iamIdentityService.DeleteAPIKey(deleteAPIKeyOptions)
if err != nil {
  panic(err)
}

Avant de commencer

Avant de pouvoir gérer les clés API d'ID de service à l'aide de Terraform, assurez-vous d'avoir effectué les opérations suivantes :

• Installez le CLI Terraform et configurez le plug-in IBM Cloud Provider pour Terraform. Pour plus d'informations, voir le tutoriel Getting started with Terraform sur IBM Cloud®. Ce plug-in résume les API IBM Cloud utilisées pour effectuer cette tâche.
• Créez un fichier de configuration Terraform nommé main.tf. Dans ce fichier, vous définissez les ressources en utilisant le langage de configuration HashiCorp. Pour plus d'informations, voir la documentation de Terraform.

Créer une clé API pour un identifiant de service à l'aide de Terraform

Suivez les étapes suivantes pour créer une clé API pour un identifiant de service à l'aide de Terraform.

1. Créez un argument dans votre fichier main.tf. L'exemple suivant crée une clé API pour un identifiant de service en utilisant la ressource ibm_iam_service_api_key, où name est un nom unique pour identifier la clé API du service. Vous devez disposer d'un identifiant IAM du service pour effectuer cette tâche.

   resource "ibm_iam_service_id" "serviceID" {
    name = "servicetest"
   }
   
   resource "ibm_iam_service_api_key" "testacc_apiKey" {
    name = "testapikey"
    iam_service_id = ibm_iam_service_id.serviceID.iam_id
   }
   

   Pour plus d'informations, voir les détails de la référence des arguments sur la page Terraform Identity and Access Management(IAM ).

2. Une fois que vous avez fini de construire votre fichier de configuration, initialisez le CLI Terraform. Pour plus d'informations, voir Initialisation des répertoires de travail.

   terraform init
   

3. Fournir les ressources à partir du fichier main.tf. Pour plus d'informations, voir Provisionnement de l'infrastructure avec Terraform.

   1. Exécutez terraform plan pour générer un plan d'exécution Terraform afin de prévisualiser les actions proposées.

      terraform plan
      

   2. Exécutez le site terraform apply pour créer les ressources définies dans le plan.

      terraform apply
      

Mise à jour d'une clé API pour un identifiant de service à l'aide de Terraform

Suivez les étapes suivantes pour mettre à jour une clé API pour un identifiant de service à l'aide de Terraform :

1. Créez un argument dans votre fichier main.tf. Vous pouvez mettre à jour la clé API pour un identifiant de service en ajoutant de nouvelles valeurs aux options name et iam_service_id dans l'exemple suivant.

   resource "ibm_iam_service_id" "serviceID" {
    name = "servicetest"
   }
   
   resource "ibm_iam_service_api_key" "testacc_apiKey" {
    name = "testapikey"
    iam_service_id = ibm_iam_service_id.serviceID.iam_id
   }
   

   Pour plus d'informations, voir les détails de la référence des arguments sur la page Terraform Identity and Access Management(IAM ).

2. Une fois que vous avez fini de construire votre fichier de configuration, initialisez le CLI Terraform. Pour plus d'informations, voir Initialisation des répertoires de travail.

   terraform init
   

3. Fournir les ressources à partir du fichier main.tf. Pour plus d'informations, voir Provisionnement de l'infrastructure avec Terraform.

   1. Exécutez terraform plan pour générer un plan d'exécution Terraform afin de prévisualiser les actions proposées.

      terraform plan
      

   2. Exécutez le site terraform apply pour créer les ressources définies dans le plan.

      terraform apply
      

Suppression d'une clé API pour un identifiant de service à l'aide de Terraform

Vous devez avoir créé la clé API pour un identifiant de service à l'aide du fichier Terraform. Suivez les étapes suivantes pour supprimer une clé API pour un identifiant de service à l'aide de Terraform.

1. L'exemple suivant montre comment supprimer la clé API d'un identifiant de service.

   resource "ibm_iam_service_id" "serviceID" {
    name = "servicetest"
   }
   
   resource "ibm_iam_service_api_key" "testacc_apiKey" {
    name = "testapikey"
    iam_service_id = ibm_iam_service_id.serviceID.iam_id
   }
   

   Pour plus d'informations, voir les détails de la référence des arguments sur la page Terraform Identity and Access Management(IAM ).

2. Une fois que vous avez fini de construire votre fichier de configuration, initialisez le CLI Terraform. Pour plus d'informations, voir Initialisation des répertoires de travail.

   terraform init
   

3. Fournir les ressources à partir du fichier main.tf. Pour plus d'informations, voir Provisionnement de l'infrastructure avec Terraform.

   1. Exécutez terraform plan pour générer un plan d'exécution Terraform afin de prévisualiser les actions proposées.

      terraform plan
      

   2. Exécutez le site terraform apply pour créer les ressources définies dans le plan.

      terraform apply
      

Examen des clés API d'ID de service ayant fait l'objet d'une fuite à l'aide de la console

Si une fuite de clé API d'ID de service est détectée, vous pouvez utiliser la console pour l'examiner. Procédez comme suit :

1. Connectez-vous à la console Web IBM Cloud.
2. Sélectionnez le compte qui contient la clé API de l'ID de service de fuite.
3. Allez dans Manage > Access > Service IDs.
4. Sélectionnez le nom de l'ID de service.
5. Sélectionnez Clés d'API.
6. Sélectionnez le nom de la clé API divulguée pour la consulter.

Examen des clés API d'ID de service ayant fait l'objet d'une fuite à l'aide de l'interface de gestion (CLI)

Si une fuite de clé API d'ID de service est détectée, vous pouvez utiliser la CLI pour la vérifier. Procédez comme suit :

1. Connectez-vous à l'interface de ligne de commande IBM Cloud.

2. Exécutez la commande suivante :

   ibmcloud iam service-api-key <API_key_ID> <service_id_name>