organization_plugin list

Description

組織プラグイン一覧を出力します。

Examples

基本的な使い方

以下のコマンドは、組織org1の組織プラグイン一覧をCSV形式で出力します。

$ annofabcli organization_plugin list --organization org1 --format csv --output out.csv

CSV形式の場合、 project_extra_data_kinds と detail はJSON文字列として出力します。

出力結果

CSV出力

$ annofabcli organization_plugin list --organization org1 --format csv --output out.csv

JSON出力

$ annofabcli organization_plugin list --organization org1 --format pretty_json --output out.json

out.json

[
    {
        "organization_id": "12345678-abcd-1234-abcd-1234abcd5678",
        "plugin_id": "plugin1",
        "plugin_name": "Custom Annotation Editor",
        "description": "独自のアノテーションエディタです。",
        "detail": {
            "type": "AnnotationEditor",
            "url": "https://example.com/editor?project_id={projectId}&task_id={taskId}",
            "auth_redirect_url": "https://example.com/oauth/callback",
            "compatible_input_data_types": [
                "image"
            ]
        },
        "is_builtin": false,
        "project_extra_data_kinds": [],
        "created_datetime": "2026-01-23T03:02:56.478+09:00",
        "updated_datetime": "2026-01-23T03:02:56.478+09:00"
    },
    ...
]

Usage Details

組織プラグイン一覧を出力します。

usage: annofabcli organization_plugin list [-h] [--yes]
                                           [--endpoint_url ENDPOINT_URL]
                                           [--annofab_user_id ANNOFAB_USER_ID]
                                           [--annofab_password ANNOFAB_PASSWORD]
                                           [--annofab_pat ANNOFAB_PAT]
                                           [--logdir LOGDIR] [--disable_log]
                                           [--debug] -org ORGANIZATION
                                           [-f {csv,json,pretty_json}]
                                           [-o OUTPUT]

Named Arguments

-org, --organization

対象の組織名を指定してください。

-f, --format

Possible choices: csv, json, pretty_json

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

Default: 'csv'

-o, --output

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

global optional arguments

--yes

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

--endpoint_url

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

Default: 'https://annofab.com'

--annofab_user_id

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

--annofab_password

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

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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