Schematics API の利用

Identity and Access Management トークンを使用して認証する IBM Cloud® Schematics API の使用方法について説明します。

IBM Cloud Schematics API を利用するには、 IBM Cloud の認証情報を使用して生成された IBM Cloud® Identity and Access Management （IAM）トークンを指定する必要があります。 IBM Cloud での認証方法に応じて、IBM Cloud IAM トークンの作成を自動化するための次のオプションから選択できます。

1. IBM Cloud IAM アクセス・トークンを作成します。

API トークン要求の要求本文は、 IBM Cloud 認証方式によって異なります。

IBM Cloud のIAMトークンは、API出力の「 access_token 」フィールドで確認できます。 次のステップでさらにヘッダー情報を取得するため、IBM Cloud IAM トークンをメモしておきます。

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

出力例

{
"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. 処理対象のトークンのアカウント ID を取得します。

<iam_access_token> を、前の手順で取得した API 出力の「 access_token 」フィールドから取得した IAM トークンに置き換えてください。 APIの出力結果では、「 resources.metadata.guid 」フィールドに、 IBM Cloud アカウント IDが表示されます。

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

出力例

{
    "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. IBM Cloud 資格情報と、作業するアカウント ID が含まれる、新しい IBM Cloud IAM トークンを生成します。

IBM Cloud API キーを使用する場合、API キーの作成対象となった IBM Cloud アカウント ID を使用する必要があります。 アカウント B 内の Schematics ワークスペースまたはアクションにアクセスするには、アカウント B にログインし、アカウント B に基づく IBM Cloud API キーを作成します。

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
}

APIの出力結果の「 access_token 」フィールドに IBM Cloud のIAMトークンが、「 refresh_token 」フィールドにリフレッシュトークンが表示されます。

4. Schematics API を使用して、アカウント内のすべてのワークスペースをリストします。

すべてのワークスペースを一覧表示する構文

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

特定のワークスペースに関する情報を取得するための構文：

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

5. サポートされる APIs のリストについては、 IBM Cloud Schematics API 資料 を参照してください。

API を使用して、 IBM Cloud の IAM アクセストークンを更新し、新しいトークンを取得する

IBM Cloud® Identity and Access Management (IAM) アクセストークンの有効期限は1時間です。 IBM Cloud API へのアクセスを確保するには、アクセス・トークンを定期的にリフレッシュする必要があります。 同じ手順で新しいトークンを取得できます。

作業を開始する前に、新しいアクセストークンのリクエストに使用できる、有効な IBM Cloud のIAMリフレッシュトークン、または IBM Cloud のAPIキーを必ず用意してください。

• リフレッシュ・トークン: IBM Cloud API を使用したワークスペースの作成と管理のプロセスの自動化 の説明に従います。
• **APIキー： **IBM Cloud APIキーを以下の手順で取得してください。
  1. メニュー・バーから、「管理」 > **「アクセス (IAM)」**をクリックします。
  2. **「ユーザー」**ページをクリックして、自分を選択します。
  3. API キー ペインで、IBM Cloud API キーの作成をクリックします。
  4. API キーの**「名前」と「説明」を入力し、「作成」**をクリックします。
  5. **「表示」**をクリックして、生成された API キーを確認します。
  6. API キーをコピーして、新しい IBM Cloud IAM アクセス・トークンを取得できるようにします。

IBM Cloud IAM トークンを作成する場合、または新しいリフレッシュ・トークンを取得する場合は、以下の手順を使用します。

1. リフレッシュ・トークンまたは IBM Cloud API キーを使用して、新しい IBM Cloud IAM アクセス・トークンを生成します。

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

         `uaa_client_secret` キーは値を指定せずに追加します。 |

API 出力の例

{
    "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
}

新しい IBM Cloud のIAMトークンは「 access_token 」に、リフレッシュトークンはAPI出力の「 refresh_token 」フィールドに記載されています。

2. 前の手順で取得したトークンを使用して、 IBM Cloud Schematics APIのドキュメントを引き続き参照してください。