6.4. テナント更新

PUT /1/_sysadm/_/tenants/(tenantId)

テナント情報を更新する

Request Headers:
 
  • X-Developer-Token -- 管理者用セッショントークン（必須）
  • Content-Type -- application/json, application/yaml のいずれか
Parameters:
  • tenantId (string) -- テナントID
Status Codes:
Response JSON Object:
 
  • tenant (object) -- 更新したテナント情報

リクエストボディ

JSON もしくはYAML 形式で記述された更新データを指定する。

YAML形式によるレートリミット設定を更新するリクエストの例を以下に示す。

tenant:
  rateLimitSetting:
    total: 0
    customApi:
      api01: 5000
      api03: 200

以下パラメータについては、システム管理者のみ更新可能。

プロパティ 名称
enabled テナント有効フラグ
authType 認証方式
ldapSetting LDAPサーバ設定
～.loginAttribute ログイン属性
～.hostName ホスト名
～.port ポート
～.accountName アカウント
～.password パスワード
～.baseDn Base DN
mongoConnectionConfig MongoDB 個別接続設定
～.servers MongoDB サーバ定義
～.username 認証用ユーザ
～.password 認証用パスワード
rateLimitSetting レートリミット設定
～.total テナント全体のリミット値
～.customApi カスタムAPI毎のリミット値設定

authTypeには、以下のいずれか１つのみを指定可能とする。

  • NORMAL : 通常認証
  • LDAP : 通常認証＋LDAP認証

LDAPを指定する際、ldapSettingsのloginAttribute, hostName, baseDnを一度も設定していない場合は必須パラメータとなる。

レスポンス

更新したテナント情報を含む JSON データが返却される。 形式は、テナント作成 レスポンスと同様。

注意事項

  • システム管理者またはテナント管理者の権限が必要。
  • テナントIDは更新不可。
  • テナント管理者権限では所属テナント情報のみ更新可能。
  • テナント管理者権限では更新可能情報が限定される。
  • リクエストボディで指定するフィールドのみを更新する。
  • 対象テナントに外部認証ユーザが存在する場合は認証方式の変更不可。
  • specialBucketのACL(contentACL)を更新する場合は、全ての権限を設定すること。更新はACL単位で行われるため、指定を省略した権限については空配列が設定される。