API キーの追加

APIキーが外部クライアントに割り当てられると、外部クライアントは管理システムのデータにアクセスし、対話することができます。 相互作用は、REST APIコールの apikey クエリパラメータまたは apikey リクエストヘッダとしてAPIキーを使用することで行われる。 API 鍵を使用する REST API 呼び出しでは、永続的なサーバー接続は作成されないため、外部クライアントが実行するすべての REST API 要求に API 鍵を含める必要があります。

始める前に

APIキーの追加時に証明書を挿入する場合は、必ず事前に認証局から証明書を取得してください。

手順

  1. API キー ・アプリケーションで、 「API キーの追加」をクリックします。
  2. 「API キーの追加」 ダイアログの 「ユーザー」 フィールドで、API キーを作成するユーザーを選択します。
  3. APIキーの有効期限を指定する場合は、 有効期限を分単位または日付で設定します。 有効期限を分単位で指定したい場合は、オフに設定します。
  4. 追加するAPIキーの証明書を挿入したい場合は、 Certificateを trueに設定する。
    Insert certificate フィールドが表示される。
  5. Insert certificate（証明書の挿入） フィールドに、有効で一意の証明書を貼り付ける。
    証明書は、 -----BEGIN CERTIFCATE----- で始まり、 -----END CERTFICATE----- で終わる形式でなければならない。 PEM X.509 規格に適合していなければならない。
    次の例は、証明書のサンプルである：
    -----BEGIN CERTIFICATE-----
MIIEAzCCAuugAwIBAgIQQoHZvObaTzAOe7m+/xDF8DANBgkqhkiG9w0BAQsFADCB
hjELMAkGA1UEBhMCR0IxDzANBgNVBAcTBkxvbmRvbjEPMA0GA1UECRMGTG9uZG9u
MS4wLAYDVQQLEyVJQk0gTWF4aW1vIEFwcGxpY2F0aW9uIFN1aXRlIChQdWJsaWMp
MSU.............................................................
EAxMxbWFuYWdlLmZyYW1l...........................................
MDQyNC5hcHBzLm1hbmFnZS1vY3AyLmNwLmZ5cmUuaWJtLmNvbTCCASIwDQYJKoZI
hvcNAQEBBQADggEPADCCAQoCggEBAPs7owfsm9eZV5z3XQSFCLY3DgnIubJwksrj
BFs+t57O/Ly9w5vZki4VnKkpZ7ZWcICKdGHRO8bFK8UdufDDhgd21YczlQbOlfHh
YemAL2wZUNo8kDp1XyBJn8z53F/cI+Ag1oxYBHhhFzgl4tInQ0IQlhU/nCSPQQ2k
72DIiFz/K593BqMTOv35nVNZJWd2YvkLqJrNYtTnRpf1/o6gLs/qOzKwmDvwiQhv
uhDwIfSn3kVk/EvcSXndlBuRWIuhjMc3uhB3dPnOLwR8VSoy5JhPyGbPIcpupODH
TmYqJjrNqoPgSVBLlTcfxMZOVTGZZzC9PV8Qv55ADNb045ehE6MCAwEAAaOBtTCB
sjAOBgNVHQ8BAf8EBAMCBaAwDAYDVR0TAQH/BAIwADAfBgNVHSMEGDAWgBQJ5HnO
................................ajBogjFtYW5hZ2UuZnJhbWUwNDI0LmFw
cHMubWFuYWdlLW9jcDIuY3AuZnlyZS5pYm0uY29tgjMqLm1hbmFnZS5mcmFtZTA0
MjQuYXBwcy5tYW5hZ2Utb2NwMi5jcC5meXJlLmlibS5jb20wDQYJKoZIhvcNAQEL
BQADggEBACFOl5PI2VTDkI8uUmB1ZnUZkTTdsXjpAc9QZTCpwgS42drq9PFdJRir
5cUQBsRsfnXTTywKor01NkMf5rrgZwomqwDXl6fGJyODGEdbICN1x8VNGuAEkmxK
fmly/MMKQRyl7xbFOvCITxNNNwL+VpLovtTOi46aK82qg5dBHRy7sBmwT3mKmnvz
................................................................
/hwjphuBId3imKjz6dZculYspxg39NmHhDTsMUqugNSoROJkZ1vGkdRK9kQSchaE
7ckHUx1cFCG/86................=
-----END CERTIFICATE-----
    注:
    • 証明書を挿入しない場合は、通常のAPIキーが作成される。
    • 無効な証明書を挿入すると、システムはエラーで応答する。
    • 重複した証明書を挿入した場合、システムはそれを受け付けない。
    • 証明書には有効期限があります。 APIキーに有効期限を設定した場合は、どちらか早い方が適用されます。
  6. CreateをクリックしてAPIキーを追加します。
    有効期限と証明書ベースのAPIキーかどうかは、APIキーを作成した後、APIアプリケーションの結果カードで確認できます。

次の作業

APIキーの追加時に証明書を挿入する場合は、ユーザー・インターフェースの信頼済み証明書に追加する必要があります。 Maximo® Application Suite に追加する必要があります。
  1. スイート管理メニューからワークスペースに移動し、 管理タイルを選択します。
  2. 操作 > 設定の更新をクリックします。
  3. Update Manage 構成ウィンドウで、 インポートされた証明書の行の [Edit] アイコンをクリックします。
  4. Add をクリックしてエイリアス名を指定し、証明書の内容を貼り付ける。
  5. 「確認」をクリックします。
  6. Apply changes（変更を適用する）をクリックして、設定の変更を保存します。
証明書を受け入れるには WebSphere® Application Server Liberty 証明書を受け入れるには、ルートを設定する必要があります。
  1. 管理者認証情報を使用して、 Red Hat® OpenShift® ウェブコンソールにログインします。
  2. サイドナビゲーションメニューから、をクリックしてください 管理 > CustomResourceDefinitions。
  3. そのページで CustomResourceDefinitions ページで、 ManageWorkspace を検索する。
  4. manageworkspaceをクリックし、 Instances タブをクリックします。
  5. インスタンスを選択し、 YAML タブをクリックする。
  6. spec.settings.deployment セクションに、 certPassthroughRoute: true を追加する。
  7. 「保管」をクリックします。 自動的に再調整が開始され、完了後、 [ネットワーク] > [ルート] に移動すると新しいルートを確認できます。
    注： certPassthroughRoute プロパティを false に設定した場合、ルートは削除されません。 手動でルートを削除する必要があります。