CSV ファイルをアップロードして、Anaplan テナント内でユーザーを作成または更新できます。ユーザーはユーザー名 (メール アドレス) に基づいて照合されます。
各行には、ユーザーの完全な定義と、そのユーザーに対する一つ以上のライセンスを含める必要があります。ライセンスは二重引用符で囲み、カンマで区切って記述してください。
メソッドとエンドポイント
PUT
/admin/1/0/users/import
パラメーター
| ヘッダー | 必須 | 説明 |
Authorization:AnaplanAuthToken {anaplan_auth_token} | 必須 | Anaplan 認証トークン。 |
Content-Type: multipart/form-data | 必須 | リクエストの形式。multipart/form-data のみがサポートされています |
Curl のサンプル
CURL -X PUT 'https://api.anaplan.com/admin/1/0/users/import' \
-H 'Authorization:AnaplanAuthToken {anaplan_auth_token}' \
-H "Content-Type: multipart/form-data" \
-F "file=@users_chunk1.csv"
レスポンス
成功
リクエストが成功した場合、API は HTTP 207 マルチステータス コードを返します。
| 成功コード | レスポンス | 説明 |
207 | accepted | アップロードされたファイル内で見つかったレコードの数。 |
created | ユーザー作成につながったレコードの数。 | |
updated | ユーザー更新につながったレコードの数。 | |
errors | エラーのリストを含むオブジェクト。行番号とエラーの理由への参照が含まれています。
|
失敗
リクエストが失敗した場合、API はエラー コードを返します。
| エラー コード | エラー メッセージ | 説明 |
400 | INVALID_PAYLOAD | 想定されるペイロード形式は CSV ファイルのバイナリ表現です。 |
INVALID_PAYLOAD | CSV ファイルにヘッダーがありません。 | |
INVALID_PAYLOAD | CSV ファイルにヘッダーがありません。想定されるヘッダー: username,first_name,last_name,licenses | |
INVALID_PAYLOAD | CSV には少なくとも一つのデータ行が含まれている必要があります。 | |
INVALID_PAYLOAD | CSV リソースが無効です。最大行数は 500 行です。 | |
INVALID_PAYLOAD | CSV リソースが無効です。行番号にエラーがあります。 | |
INVALID_PAYLOAD | CSV リソースが無効です。行番号に空のセルがあります。 | |
INVALID_PAYLOAD | CSV リソースが無効です。行番号に重複するメール アドレスがあります。 | |
401 | UNAUTHORIZED | 認証トークンが欠落しているか、無効です。 |
403 | FORBIDDEN | ユーザーはこの操作の実行を許可されていません。 |
関連コンテンツ
エクスポート エンドポイントに関する情報を確認してください。