project_member list#

Description#

プロジェクトメンバ一覧を出力します。

Examples#

基本的な使い方#

--project_id に出力対象のプロジェクトのproject_idを指定してください。

$ annofabcli project_member list --project_id prj1 prj2

出力結果#

CSV出力#

$ annofabcli project_member list --project_id prj1  --format csv --output out.csv

out.csv

JSON出力#

$ annofabcli project_member list --project_id prj1  --format pretty_json --output out.json

out.json#

[
    {
        "project_id": "prj1",
        "account_id": "12345678-abcd-1234-abcd-1234abcd5678",
        "user_id": "user1",
        "username": "test-user1",
        "biography": null,
        "member_status": "active",
        "member_role": "owner",
        "updated_datetime": "2020-12-30T22:56:45.493+09:00",
        "created_datetime": "2019-04-19T16:29:41.069+09:00",
        "sampling_inspection_rate": null,
        "sampling_acceptance_rate": null,
        "project_title": "test-project"
    },
  ...
]

user_idの一覧を出力#

$ annofabcli task list --project_id prj1 --format user_id_list --output out.txt

out.txt#

user1
user2
...

Usage Details#

複数のプロジェクトのプロジェクトメンバを出力します。

usage: annofabcli project_member list [-h] [--yes]
                                      [--endpoint_url ENDPOINT_URL]
                                      [--annofab_user_id ANNOFAB_USER_ID]
                                      [--annofab_password ANNOFAB_PASSWORD]
                                      [--mfa_code MFA_CODE] [--logdir LOGDIR]
                                      [--disable_log] [--debug] -p PROJECT_ID
                                      [PROJECT_ID ...] [--include_inactive]
                                      [-f {csv,json,pretty_json,user_id_list}]
                                      [-o OUTPUT] [--csv_format CSV_FORMAT]
                                      [-q QUERY]

Named Arguments#

-p, --project_id

ユーザを表示するプロジェクトのproject_idを指定してください。 file:// を先頭に付けると、一覧が記載されたファイルを指定できます。

--include_inactive

脱退しているメンバも出力します。

-f, --format

Possible choices: csv, json, pretty_json, user_id_list

出力フォーマットを指定します。

Default: "csv"

-o, --output

出力先のファイルパスを指定します。未指定の場合は、標準出力に出力されます。

--csv_format

CSVのフォーマットをJSON形式で指定します。 --format が csv でないときは、このオプションは無視されます。 file:// を先頭に付けると、JSON形式のファイルを指定できます。指定した値は pandas.DataFrame.to_csv の引数として渡されます。

-q, --query

JMESPath形式で指定します。出力結果の抽出や、出力内容の変更に利用できます。

global optional arguments#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: "https://annofab.com"

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--mfa_code

Annofabにログインする際のMFAコード

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。