5.4.3　初期シークレット発行

機能

初期シークレットを発行します。

マネージャーと連携するためには，認証対象となるクライアントごとに，クライアントシークレットの割り当てが必要です。クライアントシークレットを取得するまでのマネージャーとの連携では，マネージャーに対して1つ割り当てられ，すべての要求元で共有する初期シークレットを一時的に使用できます。

発行したシークレットは，統合エージェントホスト管理DBに保存されます。

実行権限

次の権限が必要です。

• JP1資源グループ：*

• JP1権限レベル：JP1_Console_Admin

APIのバージョン

v1

形式

リクエスト行

POST /application/component/apiVersion/secret/generateInfo httpVersion

リクエストのメッセージボディー

なし

レスポンスのメッセージボディー

{
  "secret": 認証用のシークレット,
  "lastUpdateTime": シークレットの生成日時
}

パラメーター

なし

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	メッセージ	説明
200	−	APIの処理が成功しました。
403	KAJY01000-E	認証に使用したユーザーの権限不足です。
500	KAJY68001-E	DBアクセスエラー

戻り値

ステータスコードが200の場合に，レスポンスボディーに次の情報を返します。

メンバー名	データ型	説明
secret	string	発行したシークレット
lastUpdateTime	string	シークレットの発行日時 形式はISO8601の拡張形式のUTC時刻「YYYY-MM-DDThh:mm:ssZ」です。

エラーメッセージの出力について

APIの実行時にエラーが発生した場合，APIのレスポンスにエラーメッセージの内容を含めて呼び出し元へ返却します。呼び出し元は受け取ったレスポンスの情報を使って，呼び出し元でメッセージの表示を行います。

使用例

APIの使用例を次に示します。

リクエスト：

POST http://immhost01:20703/im/api/v1/secret/generateInfo

マネージャーホスト名：immhost01

レスポンス：

< HTTP/1.1 200 OK
< Content-Type: application/json
 
{
    "secret": "発行したシークレット",
    "lastUpdateTime": "2022-10-20T12:25:45Z"
}

ページの先頭へ