CLIの認証
ローカルでのログイン、CI用の認証情報の指定、コマンドの実行に使われる認証主体の確認方法を説明します。
CLIは、利用可能な認証情報のうち、優先順位が最も高いものを使用します。優先順位は、コマンド実行時のグローバルオプション--api-key、LINGO_API_KEY、~/.lingo/credentials.jsonに保存されたキーまたはブラウザセッションの順です。アカウントを切り替える際は、この順序に注意してください。新たにログイン情報を保存しても、シェルですでに指定されているキーより優先されることはありません。
ログイン #
lingo login
lingo whoamiキーを指定せずにログインすると、ブラウザでOAuth認証が始まり、セッションが保存されます。CLIは有効期限が近づくとセッションを更新します。更新に失敗した場合は、もう一度ログインしてください。
ログインに成功しても、組織の設定が完了したり、すべての組織のSSO要件が満たされたりするわけではありません。リンクの操作でウェブアプリに戻された場合は、その組織の設定またはSSOでのログインを完了してから、もう一度お試しください。
lingo login --api-key <value>はキーを検証して保存します。一方、別のコマンドに指定するグローバルオプション--api-keyは、その実行時にのみ適用されます。オプションと値を分ける形式と、--api-key=value形式の両方に対応しています。コマンドラインで指定したシークレットは、シェルの履歴、プロセスの調査、診断情報などに表示される可能性があります。コマンドラインで直接指定するのではなく、シークレットを注入する仕組みを利用してください。
CLIは、認証情報用のディレクトリをモード0700で、認証情報ファイルをモード0600で作成します。
認証主体の確認 #
lingo whoami --json実行結果には、認証の種類と、利用可能な組織およびローカライゼーションエンジンのコンテキストが表示されます。このコマンドは、オンラインで認証情報を検証します。接続に失敗した場合は、保存済みの情報の一部を返すことがあります。ただし、認証が拒否された場合、有効な認証主体を確認できたことにはなりません。
チェックアウトをリンクする前に、この認証主体を確認してください。保存済みのリソースIDは使用する対象を指定するものであり、そのリソースを使用する権限を認証情報に付与するものではありません。
ログアウト #
lingo logoutログアウトすると、保存済みの認証情報が削除されます。ただし、環境変数のキーや実行時のフラグによって、その後のコマンドでも認証される場合があります。その認証情報の使用をやめる場合は、シェル側の上書き設定を削除してください。ログアウトしても、キーの失効、リソースの削除、プロジェクトのリンク解除は行われません。
CI #
ランナーのシークレット管理の仕組みを使ってLINGO_API_KEYを指定し、シークレットを含まないプロジェクト設定だけをコミットしてください。CLIは対象プロジェクトのルートディレクトリから実行してください。開発者のホームディレクトリにあるセッションをCIにコピーしないでください。
標準のGitHub連携には、独自の権限と実行承認の仕組みがあり、自己管理のCLIランナーとは別に扱われます。