5.4.5　IMクライアントシークレット発行

機能

IMクライアントシークレットを発行します。

マネージャーホストに対して，ユーザー独自のOSS，または，JP1/IM - Managerが提供するCloudWatch Logs/AzureMonitorとの連携ツールや下位マネージャーと連携する場合，IMクライアントシークレットを使用して，インテリジェント統合管理基盤と連携先との通信で認証を行います。

実行権限

次の権限が必要です。

• JP1資源グループ：*

• JP1権限レベル：JP1_Console_Admin

APIのバージョン

v1

形式

リクエスト行

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

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

{
    "clientId": IMクライアントID
}

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

{
  "clientSecret": 認証用のIMクライアントシークレット,
  "lastUpdateTime": IMクライアントシークレットの発行日時
}

リクエストのメッセージボディーに指定するパラメーターを次に示します。

メンバー名	データ型	省略可否	説明
clientId	string	不可	発行するIMクライアントシークレットのIDを指定します。 JP1/IMと連携する場合，リストの要素には，任意の文字列を指定できます。 ただし，次の文字列は指定できません。 「AGENT_」で始まる文字列 「MANAGER_」で始まる文字列 指定できる文字数は1〜280文字で，指定できる文字はASCIIコード（0x20〜0x7e（「:」を除く））です。

ステータスコード

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

ステータスコード	メッセージ	説明
200	−	APIの処理が成功しました。
400	KAJY68002-E	リクエストパラメーターが不正です。
400	KAJY68004-E	同じIMクライアントIDで登録済みです。
403	KAJY01000-E	認証に使用したユーザーの権限不足です。
500	KAJY68008-E	DBアクセスエラー

戻り値

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

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

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

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

使用例

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

リクエスト：

POST http://immhost01:20703/im/api/v1/secret/client/generateInfo
{
    "clientId": "clientSecret1"
}

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

レスポンス：

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

ページの先頭へ