cybozu.com 共通 API ドキュメント

ユーザーのログイン名を更新する

目次

ユーザーのログイン名を更新する

ユーザーのログイン名を更新します。
1 度に更新できるユーザーは、100 件までです。

CSV ファイルをインポートする API の詳細は、 ユーザー情報をインポートする を参照してください。

URL

https://sample.cybozu.com/v1/users/codes.json

HTTP メソッド

PUT

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
codes 配列 必須 ユーザーのログイン名の一覧
codes[].currentCode 文字列 必須 現在のログイン名
128 文字以下で指定します。
空文字または空白文字のみは指定できません。
codes[].newCode 文字列 必須 更新後のログイン名
128 文字以下で指定します。
空文字または空白文字のみは指定できません。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は User API の共通仕様 を参照してください。

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "codes": [
    {
      "currentCode": "user1",
      "newCode": "user1-new"
    },
    {
      "currentCode": "user2",
      "newCode": "user2-new"
    }
  ]
}

レスポンス

1

{}

制限事項

  • API の実行と同時に、画面から登録／編集したり CSV ファイルをインポートしたりした場合には、書き込まれた順に処理されます。
  • この API では、更新処理のロックは行っていません。
    そのため、画面からの登録／編集、CSV ファイルのインポート、API での操作を並行して行うことを推奨していません。