Arbeiten mit der „ Schematics “-API

Erfahren Sie, wie Sie die IBM Cloud® Schematics API mit einem Identity and Access Management Token zur Authentifizierung verwenden können.

Um mit der „ IBM Cloud Schematics “-API arbeiten zu können, müssen Sie ein IAM-Token ( IBM Cloud® Identity and Access Management ) angeben, das mit Ihren Anmeldedaten für „ IBM Cloud “ generiert wurde. Abhängig von der Methode Ihrer Authentifizierung bei IBM Cloud stehen Ihnen die folgenden Optionen zur Automatisierung der Erstellung Ihres IBM Cloud-IAM-Tokens zur Verfügung.

1. Erstellen Sie Ihr IBM Cloud-IAM-Zugriffstoken.

Der Anforderungshauptteil für Ihre API-Tokenanforderung hängt von der Authentifizierungsmethode IBM Cloud ab.

Das IAM-Token „ IBM Cloud “ finden Sie im Feld „ access_token “ Ihrer API-Ausgabe. Notieren Sie sich das IBM Cloud-IAM-Token, um weitere Headerinformationen in den nächsten Schritten abzurufen.

POST `https://iam.cloud.ibm.com/identity/token`

Beispielausgabe

{
"access_token": "<iam_access_token>",
"refresh_token": "<iam_refresh_token>",
"uaa_token": "<uaa_token>",
"uaa_refresh_token": "<uaa_refresh_token>",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1493747503
"scope": "ibm openid"
}

2. Rufen Sie die Konto-ID des Tokens ab, mit dem Sie arbeiten.

Ersetzen Sie „ <iam_access_token> “ durch das IAM-Token, das Sie im vorherigen Schritt aus dem Feld „ access_token “ Ihrer API-Ausgabe abgerufen haben. In Ihrer API-Ausgabe finden Sie die ID Ihres „ IBM Cloud “-Kontos im Feld „ resources.metadata.guid “.

GET https://accounts.cloud.ibm.com/coe/v2/accounts

Beispielausgabe

{
    "next_url": null,
    "total_results": 5,
    "resources": [
        {
            "metadata": {
                "guid": "<account_ID>",
                "url": "/coe/v2/accounts/<account_ID>",
                "created_at": "2020-09-29T02:49:41.842Z",
                "updated_at": "2020-08-16T18:56:00.442Z",
                "anonymousId": "1111a1aa1a1111a1aa11aa11111a1111"
            },
            "entity": {
                "name": "<account_name>",
            }
        }
        ]
}

3. Generieren Sie ein neues IBM Cloud-IAM-Token, das Ihre IBM Cloud-Berechtigungsnachweise und die Konto-ID enthält, mit der Sie arbeiten wollen.

Wenn Sie einen IBM Cloud-API-Schlüssel verwenden, müssen Sie die IBM Cloud-Konto-ID verwenden, für die der API-Schlüssel erstellt wurde. Um auf Schematics-Arbeitsbereiche oder -Aktionen im Konto Bzuzugreifen, melden Sie sich bei Konto B an und erstellen einen IBM Cloud-API-Schlüssel, der auf Konto B basiert.

POST https://iam.cloud.ibm.com/identity/token

Example output

{
    "access_token": "<iam_token>",
    "refresh_token": "<iam_refresh_token>",
    "token_type": "Bearer",
    "expires_in": 3600,
    "expiration": 1493747503
}

Den IAM-Token „ IBM Cloud “ finden Sie im Feld „ access_token “ und den Refresh-Token im Feld „ refresh_token “ Ihrer API-Ausgabe.

4. Verwenden Sie die Schematics-API, um alle Arbeitsbereiche in Ihrem Konto aufzulisten.

Befehl zum Auflisten aller Arbeitsbereiche

    GET https://schematics.cloud.ibm.com/v1/workspaces/

| Input parameters | Values |
| ----- |  --- |
| Header | `Authorization: bearer <iam_token>`|
{: caption="Input parameters to work with the IBM Cloud Schematics API." caption-side="top"}

Syntax zum Abrufen von Informationen zu einem bestimmten Arbeitsbereich:

GET https://schematics.cloud.ibm.com/v1/workspaces/{id}

5. Eine Liste der unterstützten APIs finden Sie in der API-Dokumentation zuIBM Cloud Schematics.

IBM Cloud-IAM-Zugriffstoken aktualisieren und neue Token über die API abrufen

Ein IBM Cloud® Identity and Access Management (IAM)-Zugangs-Token läuft nach einer Stunde ab. Sie müssen Ihr Zugriffstoken regelmäßig aktualisieren, um den Zugriff auf die IBM Cloud-API sicherzustellen. Mit denselben Schritten können Sie ein neues Token anfordern.

Bevor Sie beginnen, stellen Sie sicher, dass Sie über ein gültiges IAM-Aktualisierungstoken für „ IBM Cloud “ oder einen API-Schlüssel für „ IBM Cloud “ verfügen, mit dem Sie ein neues Zugriffstoken anfordern können.

• Aktualisierungstoken: Folgen Sie den Anweisungen unter Prozess der Arbeitsbereichserstellung und des Managements mit der IBM Cloud-API automatisieren.
• API-Schlüssel: Rufen Sie Ihren IBM Cloud API-Schlüssel wie folgt ab.
  1. Klicken Sie in der Menüleiste auf Verwalten > Zugriff (IAM).
  2. Klicken Sie auf die Seite Benutzer und wählen Sie Ihren eigenen Eintrag aus.
  3. Klicken Sie im Teilfenster API-Schlüssel auf IBM Cloud-API-Schlüssel erstellen.
  4. Geben Sie einen Namen und eine Beschreibung für Ihren API-Schlüssel ein und klicken Sie auf Erstellen.
  5. Klicken Sie auf Anzeigen, um den API-Schlüssel anzuzeigen, der für Sie generiert wurde.
  6. Kopieren Sie den API-Schlüssel, sodass Sie ihn zum Abrufen Ihres neuen IBM Cloud-IAM-Zugriffstokens verwenden können.

Führen Sie die folgenden Schritte aus, wenn Sie ein IBM Cloud-IAM-Token erstellen oder ein neues Aktualisierungstoken abrufen wollen.

1. Generieren Sie ein neues IBM Cloud-IAM-Zugriffstoken, indem Sie das Aktualisierungstoken oder den IBM Cloud-API-Schlüssel verwenden.

POST https://iam.cloud.ibm.com/identity/token

Beispiel-API-Ausgabe

{
    "access_token": "<iam_token>",
    "refresh_token": "<iam_refresh_token>",
    "uaa_token": "<uaa_token>",
    "uaa_refresh_token": "<uaa_refresh_token>",
    "token_type": "Bearer",
    "expires_in": 3600,
    "expiration": 1493747503
}

Ihr neues IAM-Token für „ IBM Cloud “ finden Sie im Feld „ access_token “, und das Refresh-Token im Feld „ refresh_token “ Ihrer API-Ausgabe.

2. Fahren Sie mit der Arbeit an der „ IBM Cloud Schematics “-API-Dokumentation fort und verwenden Sie dabei das Token aus dem vorherigen Schritt.