User APIは、ユーザーやグループ、組織、役職などの情報を操作するためのAPIです。
このページでは、User APIの共通仕様を説明します。
各APIの仕様の詳細は、それぞれのAPIのページを確認してください。

APIによって異なります。

RESOURCEは、APIによって異なります。
詳細は各APIのページを確認してください。

https://sample.cybozu.com/v1/RESOURCE

送信するリクエストに応じて次のリクエストヘッダーを指定します。
kintone REST APIリクエストを送信するAPIを使って、User APIを実行する場合、リクエストヘッダーの指定は不要です。
kintone REST APIリクエストを送信するAPI

Host

User APIを実行するドメインとポート番号（443）を、「ドメイン:ポート番号」の形式で指定します。
Hostは必須です。

Content-Type

「application/json」を指定します。
リクエストボディの形式がJSON文字列の場合のみ指定します。

X-Cybozu-Authorization

「ログイン名:パスワード」をBase64エンコードした値を指定します。
パスワードを使って認証する場合のみ指定します。
パスワード認証

Authorization

次の値を半角スペースで結合した値を指定します。

• Basic
• 「Basic認証のユーザー名:Basic認証のパスワード」をBase64エンコードした値

Basic認証を設定している場合のみ指定します。
Basic認証を設定している環境

JSON形式で指定します。文字コードはUTF-8です。

JSON文字列でエスケープが必要な文字は、\でエスケープしてください。

GETメソッドのAPIでは、URLのクエリパラメーターとしてリクエストパラメーターを付与し、リクエストを送信できます。
たとえばリクエストパラメーターのsizeが「100」の場合、クエリパラメーターは次のように指定します。

1

/v1/users.json?size=100

エスケープ

URLの仕様に従い、クエリパラメーターのキーや値はパーセントエンコーディングします。
以下は、クエリパラメーターの「code=cybozu#」をパーセントエンコーディングした例です。

1

/v1/user/organizations.json?code=cybozu%23

配列型のパラメーターを指定する場合

配列を要素に分解してパーセントエンコーディングします。

リクエストパラメーターのcodesに、「cybozu#」と「sato-noboru」を指定する例を示します。

1. codes=[cybozu#,sato-noboru]という配列を要素に分解します。

   1	/v1/users.json?codes[0]=cybozu#&codes[1]=sato-noboru

2. クエリパラメーターのキーや値をパーセントエンコーディングします。

   1	/v1/users.json?codes%5B0%5D=cybozu%23&codes%5B1%5D=sato-noboru

リクエストに成功した場合、200番台のステータスコードが返ります。
リクエストに失敗した場合、200番台以外のステータスコードとエラーレスポンスが返ります。
エラーレスポンス

次のプロパティをもつオブジェクトがJSON形式で返されます。

パラメーター名	型	説明
id	文字列	エラーID サポートへの問い合わせの際に利用します。
code	文字列	エラーの種類を表すコード
message	文字列	エラーメッセージ 出力されるメッセージの言語は、APIを実行したユーザーの表示言語の設定によって異なります。 表示言語の設定

エラーの例

1
2
3
4
5

{
  "id": "1505999166-897850006",
  "code": "CB_IJ01",
  "message": "不正なJSON文字列です。",
}

CSVファイルをインポートするAPIは、非同期APIです。
CSVファイルを使ってインポートするには、次の手順で行います。

1. ユーザー情報や組織情報などをCSV形式のファイルで用意します。
2. CSVファイルをアップロードするAPIを使って、CSVファイルをアップロードします。
   CSVファイルをアップロードするAPI
3. ファイルアップロードAPIのレスポンスとして、ファイルキーが返されます。
4. ファイルキーをリクエストパラメーターに指定して、取り込むデータに対応するAPIを実行します。
   たとえば、ユーザー情報をインポートする場合には、ユーザー情報をインポートするAPIを実行します。
   ユーザー情報をインポートするAPI
5. 実行したAPIのレスポンスとして、ジョブ番号が返されます。
6. ジョブ番号をリクエストパラメーターに指定して、インポートの結果を確認するAPIを実行します。
   インポートの結果を確認するAPI
7. 処理結果APIのレスポンスとして、処理結果が返されます。

処理結果が「処理中」の場合には、を実行し直します。
インポートの結果を確認するAPI

「*」（アスタリスク）の取り扱い

ファイルアップロードAPIを使ってアップロードするCSVの値に「*」を指定すると、その項目の値は更新されません。
ただし、CSVでユーザー情報をインポートするAPIにおいては、次の例外があります。

• ログイン名には、「*」を指定できません。
• カスタマイズ項目に「*」を指定した場合は、項目の値に「*」という文字列が設定されます。
• ファイルアップロードAPI
• CSVでユーザー情報をインポートするAPI

CSVファイルをエクスポートするAPIのレスポンスは、標準出力に出力されます。
レスポンスの内容をファイルに書き込みたい場合には、シェルのリダイレクト機能（>）を使用してください。

kintoneでは、kintone REST APIリクエストを送信するAPIを使ってUser APIを実行できます。
ただし、次のAPIは実行できません。

• kintone REST APIリクエストを送信するAPI
• ファイルアップロードAPI
• URLの末尾が.json以外のAPI

• URLの長さが4 KBを超えるGETリクエストを送信すると、「X-HTTP-Method-Override」ヘッダーが自動的に付与され、POSTリクエストとして送信されます。