--- title: auth description: CLIの認証を設定・確認し、保存した資格情報を削除する。 canonical_url: https://orchestor.io/docs/cli/auth markdown_url: https://orchestor.io/docs/cli/auth.md contentType: reference --- # auth `orc auth` は、ブラウザーで本人のアカウントを認可するか、標準入力のAPIキーを保存してCLIの認証を設定するコマンドです。現在の資格情報をサーバーで検証し、保存したCLIセッションをログアウトできます。 `orc login` と `orc logout` は `orc auth login` と `orc auth logout` の短縮形です。本人のブラウザー認可とWorkspaceのAPIキーは異なる認証方式です。資格情報をシェル引数へ直接渡す `--api-key` は非推奨です。アカウント情報の確認は [`orc whoami`](https://orchestor.io/docs/cli/whoami.md)、設定や接続の診断は [`orc status`](https://orchestor.io/docs/cli/status.md) を使用してください。 ## 使い方 ```bash title="terminal" orc auth login ``` *ブラウザーでCLIを認可します。* ## サブコマンド ### `login` 対話端末ではOrchestorの認可画面を開きます。ターミナルと画面の確認コードが一致することを確認し、CLIを認可してください。未ログインの場合は通常のログイン・登録を完了して認可画面へ戻ります。既存のWebログイン状態は再利用します。APIキーは標準入力から読み込んで保存できます。この保存だけでAPIキーの有効性を検証したとは限らないため、`auth status` で確認してください。`--web` はブラウザー認可を明示します。 ```bash title="terminal" orc auth login [options] ``` #### 固有のオプション ##### `--api-key` API key (deprecated; pipe via standard input instead) 型: `string`。任意。 ```bash title="terminal" orc auth login --api-key ``` ##### `--profile` Named credential profile to activate 型: `string`。任意。 ```bash title="terminal" orc auth login --profile ``` ##### `--scope` Credential scope: org:admin 型: `string`。任意。 ```bash title="terminal" orc auth login --scope ``` ##### `--web` Browser authorization (explicit alias) 型: `boolean`。任意。 ```bash title="terminal" orc auth login --web ``` ### `status` 現在の資格情報を `/v1/auth/validate` で検証し、`authenticated`、`valid`、取得元 `source`、認証方式 `kind`、秘密値を含まない `opaque_id`、`workspace_id`、説明 `detail` を返します。有効なら終了コード0、それ以外は1です。`auth status get` と `auth validate` は互換エイリアスです。 ```bash title="terminal" orc auth status [options] ``` ### `logout` 保存されたCLIセッションのrefresh tokenがある場合は失効を要求してから、保存したAPIキー・access token・refresh token・期限を削除します。失効に失敗した場合は再試行してください。`ORCHESTOR_API_KEY` が環境変数に残っている場合は引き続き優先されるため、完全にログアウトするにはその設定も解除します。 ```bash title="terminal" orc auth logout [options] ``` ### `credential` 現在解決される資格情報の秘密値を改行付きで標準出力へ出します。通常の診断出力とは異なる明示的な秘密情報の出力です。共有ターミナル、ログ、画面収録で実行しないでください。資格情報がない場合は終了コード2になります。 ```bash title="terminal" orc auth credential [options] ``` ## 使用例 ### APIキーを標準入力から保存します。 シェルの履歴に秘密値を直接入力せず、既存の安全な環境設定から渡します。保存後に `orc auth status` で検証してください。 ```bash title="terminal" printf '%s' "$ORCHESTOR_API_KEY" | orc auth login --workspace ``` *APIキーを標準入力から保存します。* ### 現在の認証をJSONで検証します。 ```bash title="terminal" orc auth status --json ``` *現在の認証をJSONで検証します。* ### 名前付き組織管理プロファイルでブラウザー認可します。 ```bash title="terminal" orc auth login --web --profile organization-admin --scope org:admin ``` *名前付き組織管理プロファイルでブラウザー認可します。* ## ブラウザー認可とプロファイル ブラウザー認可はWebセッションとは独立したCLIセッションを作成します。認可リクエストは10分で期限切れになります。中断した場合は `orc auth login` を再実行します。 ブラウザー認可は認証情報を保存・読み戻し、Workspaceの準備状態と次の操作を返します。ベータ参加や初回設定が必要な場合も、ログイン済みの認証情報を後続操作に使えます。 `--profile ` は認証設定を分ける名前です。`--scope org:admin` には名前付きプロファイルが必要で、`--workspace` と併用できません。 ## グローバルオプション `orc auth` では、次の[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を使用できます。 - [`--help`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%98%E3%83%AB%E3%83%97) - [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9) - [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B) - [`--format`](https://orchestor.io/docs/cli/global-flags.md#%E5%87%BA%E5%8A%9B%E5%BD%A2%E5%BC%8F) - [`--field`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--fields`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA) - [`--raw`](https://orchestor.io/docs/cli/global-flags.md#%E5%80%A4%E3%81%A0%E3%81%91%E3%82%92%E5%87%BA%E5%8A%9B) - [`--output`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E5%87%BA%E5%8A%9B) - [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%9A%E3%83%BC%E3%82%B8%E9%80%81%E3%82%8A) - [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E4%BA%8B%E5%89%8D%E7%A2%BA%E8%AA%8D) - [`--yes`](https://orchestor.io/docs/cli/global-flags.md#%E7%A2%BA%E8%AA%8D%E3%81%AE%E7%9C%81%E7%95%A5) - [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B) - [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E5%8F%96%E5%BE%97) - [`--timing`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E6%99%82%E9%96%93) - [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#%E8%AA%AD%E3%81%BF%E5%8F%96%E3%82%8A%E5%B0%82%E7%94%A8%E3%83%A2%E3%83%BC%E3%83%89) - [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#%E5%A4%96%E9%83%A8%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E7%9B%AE%E5%8D%B0%E4%BB%98%E3%81%91) 各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。 ## 関連項目 - [`orc signup`](https://orchestor.io/docs/cli/signup.md): アカウント作成とCLI認可。 - [`orc config`](https://orchestor.io/docs/cli/config.md): ローカル設定の確認。 - [`orc status`](https://orchestor.io/docs/cli/status.md): 接続・認証・導入情報の診断。 --- [Documentation index](https://orchestor.io/docs/llms.txt)