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

ユーザーを更新する

目次

ユーザー情報を更新する（JSON）

ユーザー情報を更新します。
1 度に更新できるユーザーは、100 件までです。

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

URL

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

HTTP メソッド

PUT

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
users 配列 必須 ユーザー情報の一覧
users[].code 文字列 必須 ログイン名
128 文字以下で指定します。
空文字または空白文字のみは指定できません。
users[].valid 真偽値 省略可 ユーザーの使用状態
  • true：使用中
  • false：使用停止中
省略すると「true」が設定されます。
users[].password 文字列 省略可 パスワード
64 文字以下で指定します
空文字は指定できません。
users[].name 文字列 省略可 ユーザー名
128 文字以下で指定します。
空文字または空白文字のみは指定できません。
users[].surName 文字列 省略可 姓
64 文字以下で指定します。
users[].givenName 文字列 省略可 名
64 文字以下で指定します。
users[].surNameReading 文字列 省略可 よみがな（姓）
64 文字以下で指定します。
users[].givenNameReading 文字列 省略可 よみがな（名）
64 文字以下で指定します。
users[].locale 文字列 省略可 言語
次の値を指定できます。
  • ja：日本語
  • en：英語
  • zh：中国語（簡体字）
  • zh-TW：中国語（繁体字）
  • auto：Web ブラウザーの設定に従う
省略した場合、「Webブラウザーの設定に従う」と同じです。
users[].localName 文字列 省略可 別言語での表示名
128 文字以下で指定します。
users[].localNameLocale 文字列 省略可 別言語での表示名（言語）
次の値を指定できます。
  • ja：日本語
  • en：英語
  • zh：中国語（簡体字）
  • zh-TW：中国語（繁体字）
users[].timezone 文字列 省略可 タイムゾーン
指定できる値は タイムゾーンの一覧 (External link) を参照してください。
users[].description 文字列 省略可 ユーザーの説明
1,000 文字以下で指定します。
users[].phone 文字列 省略可 電話番号
100 文字以下で指定します。
users[].mobilePhone 文字列 省略可 携帯電話番号
100 文字以下で指定します。
users[].extensionNumber 文字列 省略可 内線番号
100 文字以下で指定します。
users[].email 文字列 省略可 メールアドレス
256 文字以下で指定します。
users[].callto 文字列 省略可 Skype 名
指定できる値は Skype の制約に従います。
users[].url 文字列 省略可 URL
256 文字以下で指定します。
users[].employeeNumber 文字列 省略可 従業員番号
100 文字以下で指定します。
users[].birthDate 日付 省略可 誕生日
「YYYY-MM-DD」形式の日付、または空文字のみ指定できます。
users[].joinDate 日付 省略可 入社日
「YYYY-MM-DD」形式の日付、または空文字のみ指定できます。
users[].primaryOrganization 数値 省略可 優先する組織
ユーザーの所属組織のうち、優先する組織の組織 ID を指定します。
ユーザーの所属組織を設定してからこの API を実行する必要があります。
ユーザーの所属組織は ユーザーが所属する組織を更新する API で更新できます。
users[].sortOrder 数値 省略可 表示優先度
0 から 99,999,999 までの数値で指定します。
users[].customItemValues 配列（ CustomItemValue 型） 省略可 カスタマイズ項目の情報
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

{
  "users": [
    {
      "code": "Administrator",
      "valid": true,
      "password": "xxxyyyzzz",
      "name": "Administrator",
      "surName": "a",
      "givenName": "",
      "surNameReading": "",
      "givenNameReading": "",
      "localName": "",
      "localNameLocale": "ja",
      "timezone": "Asia/Tokyo",
      "locale": "ja",
      "description": "",
      "phone": "",
      "mobilePhone": "",
      "extensionNumber": "",
      "email": "",
      "callto": "",
      "url": "",
      "employeeNumber": "123",
      "birthDate": null,
      "joinDate": null,
      "sortOrder": 12,
      "customItemValues": [
        {
          "code": "userNameKey",
          "value": "jf"
        }
      ]
    }
  ]
}

レスポンス

1

{}

制限事項

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