organization_member invite#

Description#

組織にメンバーを招待します。

Examples#

基本的な使い方#

対象組織の名前を --organization に、招待するメンバーのuser_idを --user_id に、組織メンバーロールを --role に指定します。

--organization に file:// を先頭に付けたパスを指定すると、組織名の一覧が記載されたファイルを読み込めます。

$ annofabcli organization_member invite --organization org1 --user_id u1 u2 --role contributor

進捗と結果の出力については 一括処理のログ を参照してください。 すでに所属しているユーザと、確認に対して no と回答したユーザはスキップ件数に含まれます。

Usage Details#

組織にメンバーを招待します。

usage: annofabcli organization_member invite [-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
                                             [ORGANIZATION ...] -u USER_ID
                                             [USER_ID ...] --role
                                             {owner,administrator,contributor}

Named Arguments#

-org, --organization

招待先の組織名を指定してください。 file:// を先頭に付けると、組織名の一覧が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

-u, --user_id

組織に招待するメンバーのuser_idを指定します。 file:// を先頭に付けると、一覧が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

--role

Possible choices: owner, administrator, contributor

招待するメンバーに割り当てるロールを指定してください。

common options (after the subcommand)#

--yes

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

--endpoint_url

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

--annofab_user_id

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

--annofab_password

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

--annofab_pat

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

--logdir

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

Default: .log

--disable_log

ログを無効にします。

--debug

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

組織オーナまたは組織管理者ロールを持つユーザで実行してください。