User API の共通仕様

プロトコル

HTTPS

インターフェース

JSON

文字コード

UTF-8

エスケープ文字

\ を使用します。

リクエスト

URL

https://sample.cybozu.com/v1/リソース

リクエストヘッダー

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

パラメーター名	必須	説明
Host	必須	sample.cybozu.com:443
Content-Type	省略可	application/json リクエストボディに JSON 文字列を指定する場合は必須です。
X-Cybozu-Authorization	条件必須	「ログイン名:パスワード」を Base64 エンコードした値パスワードを使って認証する場合は必須です。詳細は、パスワード認証を参照してください。
Authorization	条件必須	「Basic 」と「"Basic認証のユーザー名:Basic認証のパスワード" を Base64 エンコードした値」を結合した値 Basic 認証を設定している場合、必須です。詳細は、 Basic 認証を設定している環境を参照してください。

レスポンス

HTTP ステータスコード

リクエストに成功した場合、200 番台のステータスコードが返ります。
リクエストに失敗した場合、200 番台以外のステータスコードが返ります。
失敗したときのレスポンスボディは、次のプロパティをもつ JSON です。

パラメーター名	型	説明
message	文字列	エラーメッセージユーザーの言語によって異なります。
id	文字列	エラーID サポートへの問い合わせの際に利用します。
code	文字列	エラーの種類を表すコード

エラーの例

1
2
3
4
5


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

CSV 形式の API

インポートするときの手順

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

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

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

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

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

ログイン名には、「*」を指定できません。
カスタマイズ項目に「*」を指定した場合は、項目の値に「*」という文字列が設定されます。

JavaScript API を使って User API を実行する

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

ファイルアップロード API
URL の末尾が .json 以外の API

注意事項

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

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