サービス資格情報管理 REST API

サブスクリプション・サービス REST API を使用して、ユーザー、サービス資格情報、およびそれらの Operational Decision Manager on Cloud 役割を管理できます。

このタスクについて

開始する前に、以下の要件を満たしていることを確認してください。

クラウド管理者権限を持っている必要があります。
すべての API 呼び出しには、呼び出しの IBM-CSRF-TOKEN ヘッダーに有効なクロスサイト・リクエスト・フォージェリー (CSRF) トークンが必要です。 CSRF トークンを取得するには、POST/instance/services/csrf_token を使用します。詳しくは、クロスサイト・リクエスト・フォージェリーの防止を参照してください。

サービス資格情報セットの作成

サービス資格情報セットを作成します。

このタスクについて

この手順では、REST API を使用してサービス資格情報を作成する方法を示します。詳しくは、クライアント・アプリケーション認証を参照してください。

プロシージャー

API 操作用のアプリケーションで、資格情報 ID 生成用の呼び出しの本文にある JSON オブジェクトに接頭部を指定します。
例えば、ローン・アプリケーションの資格情報を作成する場合、以下のような呼び出しを使用します。
```
POST /instance/services/credentials/service_credentials
...
{
  "prefix": "loanapp"
  "description": "Service credentials for loan application."  
}
```
資格情報の使用目的を簡単に識別できるように、分かりやすい説明を入力してください。
返されるオブジェクトには、機能に関連付けられた ID と、高度にセキュアなパスワードが含まれます。
注: API を使用して作成されたサービス資格情報に 許可マネージャー Operational Decision Manager on Cloud 役割を割り当てるには、ポータルまたはグループ管理 REST API を使用します。グループ管理を参照してください。

サービス資格情報のリストの取得

サブスクリプションのサービス資格情報のリストを表示します。

このタスクについて

この手順では、サブスクリプションのサービス資格情報のリストを取得する方法を示します。

プロシージャー

API 操作用のアプリケーションで、次の呼び出しを入力します。
```
GET /instance/services/credentials/service_credentials
```
サービス資格情報のリストが返されます。各エントリーには、サービス資格情報 ID、資格情報の作成者、作成時間、および説明 (該当する場合) が含まれます。
offset パラメーターおよび size パラメーターを使用して、呼び出しにページングを追加します。
```
GET /instance/services/credentials/service_credentials?offset=11&size=10
```

サービス資格情報セットの削除

サービス資格情報セットを削除します。

このタスクについて

この手順では、サービス資格情報セットを削除する方法を示します。

プロシージャー

API 操作用のアプリケーションで、次の呼び出しを入力します。

DELETE /instance/services/credentials/service_credentials/{service_credential_id}

クライアント・アプリケーション認証を参照してください。

サービス資格情報 ID とパスワードが削除されます。

サブスクリプション間でのサービス資格情報セットの共有

サービス資格情報セットをサブスクリプション間で共有します。

このタスクについて

この手順では、複数の Operational Decision Manager on Cloud サブスクリプションがある場合に、サブスクリプション間でサービス資格情報のセットを共有する方法を示します。

プロシージャー

サブスクリプションの 1 つで、ポータルまたは API のいずれかを使用して、サービス資格情報セットを作成します。
同じサブスクリプションで、API を使用してサービス資格情報インポート・トークンを作成して、他のサブスクリプションへのサービス資格情報のインポートを許可します。
```
POST /instance/services/credentials/import_tokens
...
{
  "service_credential_id": "prefix.fid@t123"
}
```
返されるオブジェクトには、インポート・トークンが含まれます。このトークンは 30 分間有効です。このインポート・トークンはサービス資格情報に固有ですが、有効期限が切れる前にサービス資格情報を複数のサブスクリプションにインポートするために再利用できます。
他のサブスクリプションで、API を使用して各サブスクリプションに資格情報をインポートすることによって、これらのサブスクリプションでクライアント・アプリケーションからサービス資格情報が使用できるようにします。
```
POST /instance/services/credentials/service_credentials/prefix.fid@t123/import
...
{
  "import_token_value": "string",
  "description": "string"
}
```
この説明は、サブスクリプションごとに異なる可能性があります。
必要に応じて、他のサブスクリプションで、ポータルを使用してインポートしたサービス資格情報にクラウド管理者役割を割り当てるか、グループ管理 API を使用して Operational Decision Manager on Cloud 役割を割り当てます。
サービス資格情報セットがサブスクリプションにアクセスする必要がなくなった場合は、クラウド・ポータルまたは API を使用して、サブスクリプションからそれらを削除できます。

サービス資格情報のパスワードの再生成

サービス資格情報のパスワードを再生成します

このタスクについて

この手順では、サービス資格情報のパスワードを再生成する方法を示します。

プロシージャー

API 操作用のアプリケーションで、次の呼び出しを入力します。

PUT /instance/services/credentials/service_credentials/{service_credential_id}/password

返されるオブジェクトには、新規パスワードである secret プロパティーが含まれています。