ユーザー名、名、姓、ライセンスの各列を含む CSV ファイルを返します。
CSV ファイルで返されるユーザー数に制限を設定できます。limit クエリ パラメーターを省略した場合、デフォルトで最初の 10 人のユーザーに制限されます。
メソッドとエンドポイント
GET
/admin/1/0/users/export
パラメーター
| ヘッダー | 必須 | 説明 |
Authorization:AnaplanAuthToken {anaplan_auth_token} | 必須 | Anaplan 認証トークン。 |
Accept: text/csv | 任意 | レスポンス タイプ。この値のデフォルトは text/csv |
| クエリ パラメーター | 必須 | 説明 |
Limit | 任意 | 返されるユーザーの最大数を設定します。省略すると、デフォルトではすべてのユーザーを返します。 |
Offset | 任意 | データ フェッチの開始点となるオフセット番号を設定します。 |
Curl のサンプル
CURL -X GET 'https://api.anaplan.com/admin/1/0/users/export'
-H 'Authorization:AnaplanAuthToken {anaplan_auth_token}' \
-H 'Accept: text/csv'
レスポンス
成功
リクエストが成功すると、HTTP 200 レスポンスと、ユーザー データを含む CSV 形式のファイルが返されます。
失敗
リクエストが失敗した場合、API はエラー コードを返します。
| ErrorCode | ErrorMessage | 説明 |
400 | INVALID | 無効なリクエスト パラメーターです。 |
401 | UNAUTHORIZED | 認証トークンが欠落しているか、無効です。 |
403 | FORBIDDEN | ユーザーはこの操作の実行を許可されていません。 |
関連コンテンツ
インポート エンドポイントに関する情報を確認してください。