17.22　ストレージシステムに設定されている外部認証サーバの検索用ユーザの情報を変更する

メモ

• 外部認証サーバと連携するための初期設定は、REST APIでは実行できません。初期設定の詳細については、お使いのストレージシステムのマニュアルを参照してください。
• VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の管理にSVPを使用している場合、このAPIを実行するにはSVPと連携する構成である必要があります。
• 1台のSVP から複数のストレージシステムを同時に接続している場合は、接続しているストレージシステムごとに、このAPIを実行してください。

• REST API を実行するユーザが、対象ストレージシステムのリソースをREST API でロックしている場合、このAPIは実行できません。その場合は、ロックを解除してから実行してください。

実行権限

セキュリティ管理者（参照・編集）

リクエストライン

PUT ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/external-authentication-server-settings/instance

このAPIはPATCHメソッドでも実行できます。

リクエストメッセージ

オブジェクトID

instanceを指定します。instanceは、単一のインスタンスしか持たないオブジェクトの場合に、オブジェクトID として指定する固定の値です。

クエリパラメータ

なし。

ボディ

{
  "ldap" : {
    "searchUserDN":"CN=search_user,DC=example,DC=com",
    "searchUserPassword":"search_password"
  }
}

属性	型	説明
ldap	Object	（必須）外部認証サーバにLDAPサーバを使用する場合の設定 searchUserDN（string） （任意）検索用ユーザのDN 1~255文字で指定します。 使用できる文字は次のとおりです。 半角英数字 次の半角記号 ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ 半角スペース searchUserPassword（string） （必須）検索用ユーザのパスワード 1~256文字で指定します。 使用できる文字は次のとおりです。 半角英数字 次の半角記号 ! # $ % & ' ( ) * + - . = @ \ ^ _ |
mappWebServerHttpsPort	int	（任意）SVPがHTTPS通信で使用するポート番号 VSP G100、G200、G400、G600、G800、VSP F400、F600、F800で、非SSL通信、またはDTLS暗号化通信方式でSSL通信を利用している場合に指定します。 省略したとき、ストレージシステム登録時に設定されたmappWebServerHttpsPortの値が使用されます。

レスポンスメッセージ

ボディ

ジョブオブジェクトを返します。ジョブオブジェクトの説明を参照してください。このAPIはaffectedResourcesを表示しません。変更が反映されたかどうかは、外部認証サーバで認証しているユーザでセッションを生成するAPIを実行し、認証に成功することを確認してください。

Actionテンプレート

なし。

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTP ステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/900000012345/external-authentication-server-settings/instance