API-Schlüssel für Service-ID erstellen

Erstellen Sie in der Konsole einen API-Schlüssel, der einer Service-ID zugeordnet werden soll:

1. Rufen Sie in der IBM Cloud-Konsole Verwalten > Zugriff (IAM) auf und wählen Sie Service-IDs aus.
2. Wenn Sie noch keine Service-ID erstellt haben, dann erstellen Sie nun die Service-ID.
3. Klicken Sie auf das Symbol Aktionen > Service-ID verwalten.
4. Klicken Sie auf API-Schlüssel.
5. Klicken Sie auf Erstellen.
6. Fügen Sie einen Namen und eine Beschreibung hinzu, um den API-Schlüssel auf einfache Weise identifizieren zu können.
7. Klicken Sie auf Erstellen.
8. Speichern Sie Ihren API-Schlüssel, indem Sie ihn an eine sichere Position kopieren oder herunterladen.

Aus Sicherheitsgründen kann der API-Schlüssel nur zum Zeitpunkt seiner Erstellung kopiert oder heruntergeladen werden. Wenn der API-Schlüssel verloren geht, müssen Sie einen neuen API-Schlüssel erzeugen.

Aktualisieren eines API-Schlüssels für eine Dienst-ID über die Konsole

Sie können einen API-Schlüssel aktualisieren, indem Sie den Namen oder die Beschreibung bearbeiten, der bzw. die zur Identifikation des Schlüssels in der Benutzerschnittstelle verwendet wird.

1. Rufen Sie in der IBM Cloud-Konsole Verwalten > Zugriff (IAM) auf und wählen Sie Service-IDs aus.
2. Klicken Sie auf das Symbol Aktionen > Service-ID verwalten.
3. Klicken Sie auf API-Schlüssel.
4. Klicken Sie auf das Symbol Aktionen > Name und Beschreibung bearbeiten.

Wenn Sie die Service-ID nicht erstellt haben, aber der Kontoeigner oder ein Administrator für IAM Identity Service sind, können Sie die API-Schlüssel für jede beliebige Service-ID im Konto aktualisieren. Rufen Sie die Seite API-Schlüssel auf und wählen Sie die Option Alle Service-ID-API-Schlüssel im Menü Anzeigen aus, um den API-Schlüssel zu suchen, mit dem Sie arbeiten möchten.

API-Schlüssel für eine Service-ID über die Befehlszeilenschnittstelle erstellen

Sie können den Befehl ibmcloud iam service-api-key-create verwenden, um einen API-Schlüssel für eine Service-ID über die Befehlszeilenschnittstelle zu erstellen.

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

API-Schlüssel für eine Service-ID über die Befehlszeilenschnittstelle aktualisieren

Wenn Sie einen API-Schlüssel für eine Service-ID über die Befehlszeilenschnittstelle aktualisieren möchten, können Sie den Befehl ibmcloud iam service-api-key-update verwenden.

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

API-Schlüssel einer Service-ID sperren

Sie können das Löschen von API-Schlüsseln, die die Identität der Service-ID darstellen, verhindern, indem Sie sie sperren. Ein gesperrter API-Schlüssel wird durch das Symbol Gesperrt in der Benutzerschnittstelle angezeigt.

1. Klicken Sie in der IBM Cloud-Konsole auf Verwalten > Zugriff (IAM) und wählen Sie Service-IDs aus.
2. Ermitteln Sie die Zeile für die Service-ID, für die Sie einen API-Schlüssel auswählen möchten, und wählen Sie den Namen der Service-ID aus.
3. Klicken Sie auf API-Schlüssel.
4. Bewegen Sie den Mauszeiger über die Zeile des API-Schlüssels, den Sie sperren möchten, und klicken Sie auf das Symbol Aktionen , um eine Liste mit Optionen anzuzeigen.
5. Klicken Sie auf API-Schlüssel sperren.

Sie können den API-Schlüssel zu jedem beliebigen Zeitpunkt entsperren, um ihn zu aktualisieren, zu löschen oder zu entfernen oder um eine Zugriffsrichtlinie hinzuzufügen.

API-Schlüssel einer Service-ID über die Befehlszeilenschnittstelle sperren bzw. entsperren

Sie können das Löschen von API-Schlüsseln, die die Identität der Service-ID darstellen, verhindern, indem Sie sie sperren. Ein gesperrter API-Schlüssel wird durch das Symbol Gesperrt in der Benutzerschnittstelle angezeigt. Verwenden Sie den folgenden Befehl, um den API-Schlüssel einer Service-ID zu sperren:

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

Voraussetzungen

Endpunkt, Anmeldung, Ziel

Befehlsoptionen:

APIKEY_NAME (erforderlich)

Der Name des API-Schlüssels, gegenseitig ausschließend mit APIKEY_UUID

APIKEY_UUID (erforderlich)

Die UUID des API-Schlüssels, gegenseitig ausschließend mit APIKEY_NAME

SERVICE_ID_NAME (erforderlich)

Der Name der Service-ID, gegenseitig ausschließend mit SERVICE_ID_UUID

SERVICE_ID_UUID (erforderlich)

Die UUID der Service-ID, gegenseitig ausschließend mit SERVICE_ID_NAME

-f, --force

Ohne Bestätigung sperren

Beispiele:

Service-API-Schlüssel sample-key der Service-ID sample-service sperren:

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

Verwenden Sie den folgenden Befehl, um den API-Schlüssel einer Service-ID zu entsperren:

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

API-Schlüssel für Service-ID löschen

Sie können einen API-Schlüssel löschen, der einer Service-ID zugeordnet ist. Allerdings wird durch das Löschen eines momentan durch eine Anwendung benutzten API-Schlüssels dieser Anwendung die Möglichkeit entzogen, sich bei Ihren Services zu authentifizieren.

1. Rufen Sie in der IBM Cloud-Konsole Verwalten > Zugriff (IAM) auf und wählen Sie Service-IDs aus.
2. Wenn Sie noch keine Service-ID erstellt haben, dann erstellen Sie nun die Service-ID.
3. Klicken Sie auf das Symbol Aktionen > Service-ID verwalten.
4. Klicken Sie auf API-Schlüssel.
5. Klicken Sie auf das Symbol Aktionen > Löschen.

Wenn Sie die Service-ID nicht erstellt haben, aber der Kontoeigner oder ein Administrator für IAM Identity Service sind, können Sie die API-Schlüssel für jede beliebige Service-ID im Konto löschen. Rufen Sie die Seite API-Schlüssel auf und wählen Sie die Option Alle Service-ID-API-Schlüssel im Menü Anzeigen aus, um den API-Schlüssel zu suchen, mit dem Sie arbeiten möchten.

API-Schlüssel für Service-ID über die Befehlszeilenschnittstelle (CLI) löschen

Sie können einen API-Schlüssel löschen, der einer Service-ID zugeordnet ist. Allerdings wird durch das Löschen eines momentan durch eine Anwendung benutzten API-Schlüssels dieser Anwendung die Möglichkeit entzogen, sich bei Ihren Services zu authentifizieren. Wenn Sie einen API-Schlüssel für eine Service-ID über die Befehlszeilenschnittstelle löschen möchten, können Sie den Befehl ibmcloud iam service-api-key-delete verwenden.

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

API-Schlüssel für eine Service-ID über die Anwendungsprogrammierschnittstelle (API) erstellen

Um einen API-Schlüssel für eine Dienst-ID zu erstellen, rufen Sie die API IAM Identity Service wie im folgenden Beispiel gezeigt auf.

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

API-Schlüssel für eine Service-ID über die Anwendungsprogrammierschnittstelle (API) aktualisieren

Um einen API-Schlüssel für eine Service-ID mit Hilfe der API zu bearbeiten, rufen Sie die IAM Identity Service API wie im folgenden Beispiel gezeigt auf:

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))

API-Schlüssel für eine Service-ID über die Anwendungsprogrammierschnittstelle (API) sperren und entsperren

Sie können das Löschen von API-Schlüsseln, die die Identität der Service-ID darstellen, verhindern, indem Sie sie sperren.

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)
}

API-Schlüssel für eine Service-ID über die Anwendungsprogrammierschnittstelle (API) löschen

Um einen API-Schlüssel für eine Dienst-ID über die API zu löschen, rufen Sie die API IAM Identity Service wie im folgenden Beispiel gezeigt auf:

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)
}

Vorbereitende Schritte

Bevor Sie die API-Schlüssel der Service-ID mit Terraform verwalten können, müssen Sie die folgenden Schritte durchführen:

• Installieren Sie die Terraform CLI und konfigurieren Sie das IBM Cloud Provider Plug-in für Terraform. Weitere Informationen finden Sie in der Anleitung zu den ersten Schritten mit Terraform auf IBM Cloud®. Das Plug-in abstrahiert die IBM Cloud APIs, die zur Erfüllung dieses Tasks verwendet werden.
• Erstellen Sie eine Terraform-Konfigurationsdatei mit dem Namen main.tf. In dieser Datei definieren Sie die Ressourcen mit Hilfe der HashiCorp Configuration Language. Weitere Informationen finden Sie in der Terraform-Dokumentation.

Erstellen eines API-Schlüssels für eine Service-ID mithilfe von Terraform

Gehen Sie wie folgt vor, um einen API-Schlüssel für eine Service-ID mithilfe von Terraform zu erstellen.

1. Erstellen Sie ein Argument in Ihrer main.tf Datei. Im folgenden Beispiel wird ein API-Schlüssel für eine Dienst-ID mithilfe der Ressource ibm_iam_service_api_key erstellt, wobei name ein eindeutiger Name zur Identifizierung des API-Schlüssels des Dienstes ist. Sie benötigen eine IAM-ID des Dienstes, um die Aufgabe zu erledigen.

   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
   }
   

   Weitere Informationen finden Sie in der Argument-Referenz auf der Terraform Identity and Access Management(IAM) Seite.

2. Nachdem Sie Ihre Konfigurationsdatei erstellt haben, initialisieren Sie die Terraform CLI. Weitere Informationen finden Sie unter Initialisierung von Arbeitsverzeichnissen.

   terraform init
   

3. Bereitstellung der Ressourcen aus der Datei main.tf. Weitere Informationen finden Sie unter Bereitstellung der Infrastruktur mit Terraform.

   1. Führen Sie terraform plan aus, um einen Terraform-Ausführungsplan zu erstellen und eine Vorschau der vorgeschlagenen Aktionen zu erhalten.

      terraform plan
      

   2. Führen Sie terraform apply aus, um die im Plan definierten Ressourcen zu erstellen.

      terraform apply
      

Aktualisieren eines API-Schlüssels für eine Service-ID mithilfe von Terraform

Verwenden Sie die folgenden Schritte, um einen API-Schlüssel für eine Service-ID mit Terraform zu aktualisieren:

1. Erstellen Sie ein Argument in Ihrer main.tf Datei. Sie können den API-Schlüssel für eine Dienst-ID aktualisieren, indem Sie im folgenden Beispiel neue Werte zu den Optionen name und iam_service_id hinzufügen.

   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
   }
   

   Weitere Informationen finden Sie in der Argument-Referenz auf der Terraform Identity and Access Management(IAM) Seite.

2. Nachdem Sie Ihre Konfigurationsdatei erstellt haben, initialisieren Sie die Terraform CLI. Weitere Informationen finden Sie unter Initialisierung von Arbeitsverzeichnissen.

   terraform init
   

3. Bereitstellung der Ressourcen aus der Datei main.tf. Weitere Informationen finden Sie unter Bereitstellung der Infrastruktur mit Terraform.

   1. Führen Sie terraform plan aus, um einen Terraform-Ausführungsplan zu erstellen und eine Vorschau der vorgeschlagenen Aktionen zu erhalten.

      terraform plan
      

   2. Führen Sie terraform apply aus, um die im Plan definierten Ressourcen zu erstellen.

      terraform apply
      

Löschen eines API-Schlüssels für eine Service-ID mithilfe von Terraform

Sie müssen den API-Schlüssel für eine Service-ID mithilfe der Terraform-Datei erstellt haben. Gehen Sie wie folgt vor, um einen API-Schlüssel für eine Service-ID mithilfe von Terraform zu löschen.

1. Das folgende Beispiel zeigt, wie Sie den API-Schlüssel für eine Dienst-ID löschen.

   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
   }
   

   Weitere Informationen finden Sie in der Argument-Referenz auf der Terraform Identity and Access Management(IAM) Seite.

2. Nachdem Sie Ihre Konfigurationsdatei erstellt haben, initialisieren Sie die Terraform CLI. Weitere Informationen finden Sie unter Initialisierung von Arbeitsverzeichnissen.

   terraform init
   

3. Bereitstellung der Ressourcen aus der Datei main.tf. Weitere Informationen finden Sie unter Bereitstellung der Infrastruktur mit Terraform.

   1. Führen Sie terraform plan aus, um einen Terraform-Ausführungsplan zu erstellen und eine Vorschau der vorgeschlagenen Aktionen zu erhalten.

      terraform plan
      

   2. Führen Sie terraform apply aus, um die im Plan definierten Ressourcen zu erstellen.

      terraform apply
      

Überprüfung von durchgesickerten Dienst-ID-API-Schlüsseln mit Hilfe der Konsole

Wenn ein durchgesickerter Dienst-ID-API-Schlüssel entdeckt wird, können Sie ihn über die Konsole überprüfen. Führen Sie die folgenden Schritte aus:

1. Melden Sie sich bei der IBM Cloud-Konsole an.
2. Wählen Sie das Konto aus, das den API-Schlüssel für die geleakte Service-ID enthält.
3. Gehen Sie zu Verwalten > Zugriff > Service-IDs.
4. Wählen Sie den Namen der Service-ID.
5. Wählen Sie API-Schlüssel aus.
6. Wählen Sie den Namen des durchgesickerten API-Schlüssels, um ihn zu überprüfen.

Überprüfung durchgesickerter Dienst-ID-API-Schlüssel mit Hilfe der CLI

Wenn ein durchgesickerter Dienst-ID-API-Schlüssel entdeckt wird, können Sie ihn mit der CLI überprüfen. Führen Sie die folgenden Schritte aus:

1. Melden Sie sich bei der IBM Cloud-CLI an.

2. Führen Sie den folgenden Befehl aus:

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