6.6. 所属ユーザ・グループの追加

PUT /1/(tenantId)/groups/(groupName)/addMembers

グループに所属ユーザ・グループを追加する。

Request Headers:  

• X-Application-Id -- アプリケーションID(必須)
• X-Application-Key -- アプリケーションキー(必須)
• X-Session-Token -- セッショントークン(オプション)
• Content-Type -- "application/json"

Parameters:

• groupName (string) -- グループ名

Request JSON Object:  

• users (array) -- 追加するユーザIDの配列(オプション)
• group (array) -- 追加するグループ名の配列(オプション)

Status Codes:

• 200 OK -- 正常に追加した
• 400 Bad Request -- リクエストボディ不正
• 401 Unauthorized -- 認証エラー
• 403 Forbidden -- 権限エラー
• 404 Not Found -- グループが存在しない
• 409 Conflict -- 更新が衝突した(request_conflicted)
• 415 Unsupported Media Type -- Content-Type不正

Response JSON Object:  

• _id (string) -- グループID
• name (string) -- グループ名
• users (array) -- 所属ユーザIDの一覧
• groups (array) -- 所属グループ名の一覧
• ACL (object) -- ACL
• createdAt (string) -- 作成日時
• updatedAt (string) -- 更新日時
• etag (string) -- ETag値
• reasonCode (string) -- 409 Conflict 時の原因コード
• detail (object) -- 409 Conflict 時のエラーデータ

リクエスト

リクエストボディに、削除するユーザID・グループ名を指定する。以下に例を示す。

{
    "users": [ "xxxxx", "yyyyy", "zzzzz" ],
    "groups": [ "group2", "group3" ]
}

レスポンス

正常時は、更新されたグループ情報の JSON が返却される。 追加に成功した場合、ETag値が更新される。

409 Conflict 時は、JSONで以下のプロパティが返却される。

• reasonCode: 原因を示すコード。"request_conflicted" 固定。
• detail: エラーに関するデータ。"Updating conflict" (文字列)固定。

注意事項

• _GROUPSバケットのcontentACLに対する update 権限、および対象グループの update 権限の両方が必要。
• GROUPSバケット、および対象グループのread権限が無くても、上記のレスポンスが返却される。
• "users" と "groups" には、既に登録済みのユーザとグループを指定すること。 未登録のユーザ・グループを指定した場合は400エラーを返却する。
• 下記の場合は200 OKを返却する。更新日時とETag値は更新される。
  • 既に所属しているユーザ・グループを指定した場合
  • "users"と "groups" を共に指定しない場合(= リクエストボディが空欄)