ユーザーを追加する
ユーザーを追加します。
1 度に追加できるユーザーは、100 件までです。
CSV ファイルをインポートする API の詳細は、 ユーザー情報をインポートする を参照してください。
URL
https://sample.cybozu.com/v1/users.json
HTTP メソッド
POST
必要なアクセス権
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
users | 配列 | 必須 | ユーザー情報の一覧 |
users[].code | 文字列 | 必須 | ログイン名 128 文字以下で指定します。 空文字または空白文字のみは指定できません。 |
users[].valid | 真偽値 | 省略可 | ユーザーの使用状態
|
users[].password | 文字列 | 必須 | パスワード 64 文字以下で指定します。 空文字は指定できません。 |
users[].name | 文字列 | 必須 | 表示名 128 文字以下で指定します。 空文字または空白文字のみは指定できません。 |
users[].surName | 文字列 | 省略可 | 姓 64 文字以下で指定します。 |
users[].givenName | 文字列 | 省略可 | 名 64 文字以下で指定します。 |
users[].surNameReading | 文字列 | 省略可 | よみがな(姓) 64 文字以下で指定します。 |
users[].givenNameReading | 文字列 | 省略可 | よみがな(名) 64 文字以下で指定します。 |
users[].locale | 文字列 | 省略可 | 言語 次の値を指定できます。
|
users[].localName | 文字列 | 省略可 | 別言語での表示名 128 文字以下で指定します。 |
users[].localNameLocale | 文字列 | 省略可 | 別言語での表示名(言語) 次の値を指定できます。
|
users[].timezone | 文字列 | 省略可 | タイムゾーン 指定できる値は タイムゾーンの一覧 |
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[].sortOrder | 数値 | 省略可 | 表示優先度 0 から 99,999,999 までの数値で指定します。 |
users[].customItemValues | 配列( CustomItemValue 型) | 省略可 | カスタマイズ項目の情報 |
リクエストの例
ヘッダー
|
|
リクエストヘッダーの詳細は User API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
|
|
サンプルコード
curl を使ったリクエスト
|
|
制限事項
- cybozu.com 共通管理における次の操作と、API の実行を並行して行うことは推奨しません。
- 組織とユーザーの設定画面における、ユーザーに対する各操作
- ファイルからの読み込み