UpdateUsersInGroupByAdmin

ユーザー情報の更新（ワークスペース管理者、グループ管理者専用）

Description

• ワークスペース管理者またはグループ管理者のみ利用可能です。
• 指定したグループに所属するユーザーのユーザー名やユーザーコード、メールアドレスを更新することができます。
• 一度に更新できるユーザーは100名までです。

Method

POST

Request URL Format

/api/v0/groups/:parent-group-id/users

Payload

Content-Type : application/json

{
  "members": [
    {
      "user_id": "6409773adce21ac6fdd466c7", // 必須.更新対象ユーザーID
      "values": {
        "user_name": "new_username",
        "user_code": "new_usercode",
        "email": "[email protected]",
      }
    },
    {
      "user_id": "xxxxxxxxxxxxxxxxxxxxxxxx",
      "values": {
        "user_name": "xxxxxxxxx",
        "user_code": "xxxxxxxxx",
        "email": "xxxxxxxxx",
      }
    }
  ]
}

Request URL Sample

POST https://api.xxx.com/api/v0/groups/GROUPID/users

Response Sample

// 成功時
{
    "has_error": false,
    "result": {
        "users": 2,    // 更新リスクエストユーザー数
        "processed": 2 // 更新完了ユーザー数
    }
}

// 既に存在している内容に更新しようとしたとき
{
    "errors": [
        {
            "description": "Email already exists",
            "error_code": "INVALID_PARAMS",
            "error_level": "ERROR",
            "reference_id": "u_id: 6409773adce21ac6fdd466c7, user_code: new_usercode, email: [email protected]"
        },
    ],
    "has_error": true,
    "result": {
        "users": 2,
        "processed": 1
    }
}

// 更新エラー（DB間のロールバックは成功）
{
    "errors": [
        {
            "description": "error in SaveUpdateUserProfile xxx",
            "error_code": "SYSTEM_ERROR",
            "error_level": "ERROR",
            "reference_id": "failed to update user in MySQL user_id: 6409773adce21ac6fdd466c7, user_code: new_usercode, email: [email protected]"
        },
    ],
    "has_error": true,
    "result": {
        "users": 0,
        "processed": 2 
    }
}

// 更新エラー（DB間のロールバックに失敗し、DB間で不整合が発生している可能性あり）
{
    "errors": [
        {
            "description": "error in Commit. Check user data consistency between MySQL, mongoDB and ArangoDB xxx",
            "error_code": "SYSTEM_ERROR",
            "error_level": "ERROR",
            "reference_id": "failed to commit MySQL user_id: 6409773adce21ac6fdd466c7, user_code: new_usercode, email: [email protected]"
        },
    ],
    "has_error": true,
    "result": {
        "users": 0,
        "processed": 2 
    }
}

// 管理者以外のユーザーでAPIを実行したとき
{
    "description": "no privirage to update user info. please exec this api by admin or group admin user.",
    "error": "invalid request user",
    "error_code": "NO_PRIVILEGES"
}