auth
@orchestor-inc/cli のコマンドリファレンスです。
orc login と orc logout は、それぞれ orc auth login と orc auth logout の短縮形です。
コマンド一覧
orc auth login— Authenticate with the Orchestor APIorc auth status— Verify the active credentialorc auth logout— Remove stored API credentialsorc auth credential— 標準出力へ現在の資格情報を明示的に出す（秘密情報）
orc auth login
Authenticate with the Orchestor API
構文
orc auth login [flags]ブラウザーで認可する
orc auth login は Orchestor の認可画面を開きます。ターミナルと画面の確認コードが一致していることを確認してください。未ログインの場合は通常のログイン・登録を別タブで完了し、認可画面に戻ります。既存のログイン状態は再利用されます。
「CLIを認可」を押すと、このCLI専用のセッションが作成されます。Webのセッションとは独立しており、orc auth logout で失効します。認可リクエストは10分で期限切れになります。ターミナルで中断した場合は再度 orc auth login を実行してください。
ワークスペースの読み取りに成功してから、資格情報を保存して完了します。
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--api-key | string | いいえ | API key (deprecated; pipe via standard input instead) |
--profile | string | いいえ | Named credential profile to activate |
--scope | string | いいえ | Credential scope: org:admin |
--web | boolean | いいえ | Orchestor browser authorization (explicit alias) |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc auth login --helporc auth status
Verify the active credential
構文
orc auth status [flags]出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc auth status getorc auth validate
ヘルプ
orc auth status --helporc auth logout
Remove stored API credentials
構文
orc auth logout [flags]出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc auth logout --helporc auth credential
標準出力へ現在の資格情報を明示的に出す（秘密情報）
このコマンドは秘密の資格情報を標準出力へ出します。共有ターミナル、ログ、画面収録で実行しないでください。
構文
orc auth credential [flags]出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc auth credential --help