5.4.4　IMクライアントシークレット削除

機能

データベースに登録されたIMクライアントシークレットを削除します。

実行権限

次の権限が必要です。

• JP1資源グループ：*

• JP1権限レベル：JP1_Console_Admin

APIのバージョン

v1

形式

リクエスト行

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

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

{
    "clientIds": [ IMクライアントID, .... ]
}

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

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

ステータスコード

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

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

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

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

使用例

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

リクエスト：

POST http://immhost01:20703/im/api/v1/secret/client/deleteInfo
 
{
    "clientIds": [ "clientId1", "clientId2" ]
}

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

レスポンス：

< HTTP/1.1 500 Internal Server Error
< Content-Type: application/json
{
    "timestamp": 1585561108345,
    "status": 500,
    "error": "Internal Server Error",
    "exception":"XXXXXXXXXXXXXXXXXXXXXXX",
    "message": "IMクライアントシークレットの削除に失敗しました。",
    "path": "/im/api/v1/secret/client/deleteInfo ",
    "messageId": " KAJY68007-E"
}

ページの先頭へ