workspace_member list

Description

メンバの一覧を出力します。無効化されたメンバも出力します。

Examples

以下のコマンドは、メンバーの一覧を出力します。

$ annoworkcli workspace_member list --workspace_id ws \
 --format json --output out.json

out.json

[
   {
      "workspace_member_id": "e2d334cf-dfe8-411e-acd6-fe4e39687fea",
      "workspace_id": "org",
      "account_id": "b7d76c01-4a10-438e-a516-d5768afb7709",
      "user_id": "alice",
      "username": "Alice",
      "role": "manager",
      "status": "active",
      "created_datetime": "2021-10-31T14:49:59.841Z",
      "updated_datetime": "2021-11-02T05:28:36.714Z"
   }
]

--show_workspace_tag を付けると、メンバーに付与されているタグの情報も出力します。

$ annoworkcli workspace_member list --show_workspace_tag \
 --format json --output out.json

out.json

[
   {
      "workspace_member_id": "e2d334cf-dfe8-411e-acd6-fe4e39687fea",
      "workspace_id": "org",
      "account_id": "b7d76c01-4a10-438e-a516-d5768afb7709",
      "user_id": "alice",
      "username": "Alice",
      "role": "manager",
      "status": "active",
      "created_datetime": "2021-10-31T14:49:59.841Z",
      "updated_datetime": "2021-11-02T05:28:36.714Z",
      "workspace_tag_ids": [
         "tag"
      ],
      "workspace_tag_names": [
         "TAG"
      ]
   }
]

Usage Details

ワークスペースメンバの一覧を出力します。無効化されたメンバも出力します。

usage: annoworkcli workspace_member list [-h] [--debug]
                                         [--annowork_user_id ANNOWORK_USER_ID]
                                         [--annowork_password ANNOWORK_PASSWORD]
                                         [--endpoint_url ENDPOINT_URL]
                                         [-w WORKSPACE_ID]
                                         [-wt WORKSPACE_TAG_ID [WORKSPACE_TAG_ID ...]
                                         | -u USER_ID [USER_ID ...]]
                                         [--show_workspace_tag]
                                         [--status {active,inactive}]
                                         [-o OUTPUT] [-f {csv,json}]

Named Arguments

-w, --workspace_id

対象のワークスペースID。未指定の場合は環境変数`ANNOWORK_WORKSPACE_ID`を使用します。

-wt, --workspace_tag_id

指定したワークスペースタグが付与されたワークスペースメンバを出力します。複数指定した場合は、すべてのワークスペースタグが付与されたワークスペースメンバーを出力します。

-u, --user_id

指定したuser_idで絞り込みます。

--show_workspace_tag

ワークスペースタグに関する情報も出力します。

--status

Possible choices: active, inactive

ワークスペースメンバーのstatusで絞り込みます。

-o, --output

出力先

-f, --format

Possible choices: csv, json

出力先のフォーマット

Default: 'csv'

global optional arguments

--debug

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

--annowork_user_id

Annoworkにログインする際のユーザーIDを指定します。

--annowork_password

Annoworkにログインする際のパスワードを指定します。

--endpoint_url

Annowork WebAPIのエンドポイントを指定します。指定しない場合は https://annowork.com です。